创建协作任务接口文档
创建协作任务
请求方式: POST(HTTPS)
请求地址: https://open.wshoto.com/openapi/task/cooperation/task/add
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 调用接口凭证 |
Body参数:
{
"task_name": "fake_data",
"priority": 1,
"cooperation_user_ids": [
"fake_data",
"fake_data1"
],
"cooperation_department_ids": [
69,
73
],
"cooperation_task_explanation": "fake_data",
"task_end_time": 1648782811,
"is_upload_progress_feedback": 1,
"cooperation_task_annex": [
"fake_data"
],
"is_timing_send": true,
"timing_send_time": 1648782389,
"create_user_id": "fake_data"
}
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
task_name | string | 是 | 任务名称 |
priority | int | 是 | 优先级 1-低;2-中;3-高 |
cooperation_user_ids | array | 否 | 协作员工ID集合 (PS:员工ID集合和部门ID集合不能同时为空) |
cooperation_department_ids | array | 否 | 协作部门ID集合 (PS:员工ID集合和部门ID集合不能同时为空) |
cooperation_task_explanation | string | 是 | 协作任务说明 |
task_end_time | long | 是 | 任务结束时间,时间戳,精度:秒 |
is_upload_progress_feedback | int | 否 | 是否需要上传进度反馈 0:否;1:是 ,不填默认为否 |
cooperation_task_annex | array | 否 | 协作任务附件Id集合,素材id集合 |
is_timing_send | bool | 是 | 是否定时发送 true:是定时发送,此时会根据timing_send_time定时发送时间的参数进行发送. false:立即发送.当业务触发的时候就会发送. |
timing_send_time | long | 否 | 定时发送时间,时间戳,精度:秒 与is_timing_send字段配合使用 当is_timing_send为true的时候,timing_send_time为必传,会作为任务推送的时间, 当is_timing_send为false的时候,timing_send_time为非必传,不会影响任务推送的时间 |
create_user_id | string | 是 | 创建人Id |
返回值:
{
"code": 0,
"msg": "请求成功",
"data": {
"cooperation_task_id": "fake_data",
"user_total": 88
}
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
code | int | 返回码,0-请求成功, |
msg | string | 对返回码的文本描述内容 |
data | object | 协作任务 |
cooperation_task_id | string | 协作任务ID |
user_total | int | 执行任务员工总数 |
补充说明
1.is_timing_send和timing_send_time:
当is_timing_send为true,同时传入timing_send_time为某个时间点的时间戳,接口服务提供方执行相关业务逻辑判断,会将timing_send_time字段的参数与当前业务系统时间进行对比.
对比结果为timing_send_time <= system_time.则会立即发送.
对比结果为timing_send_time > system_time.则会根据timing_send_time具体时间进行定时发送.
当is_timing_send为true,同时传入timing_send_time为空,则会报错.