白皮书下载
手机端任务管理
一、手机端新增任务
接口说明
该接口是为了提供手机端任务管理功能,任务新增所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/mobile/job/add
HTTP method: POST
Content-Type: application/json
请求样例
1.1 立即执行,动态分配
{
"jobName": "手机端绯世任务001", // 任务名称
"jobToProcessAddList": [
{
"processChannel": 0, // 流程渠道:0-流程,1-企业市场
"processDetailId": "1486154013735305218" // 流程详情id
}
],
"executeType": 2, // 执行类型 1-手动执行 2-立即执行 9-定时器执行
"executeTimes": 1, // 执行次数
"maxQueueWait": 180000, // 最大等待时长,单位:分
"maxQueueNumber": 30, // 最大队列数
"distributionType": 1, // 分配类型 1-自动分配 2-指定bot机器人
"priority": 5 //优先级 1~10 数值越小优先级越高,数值越大优先级越低
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
jobName |
String |
是 |
任务名称 |
|
jobToProcessAddList |
Object[] |
是 |
任务与流程数组 |
|
processChannel |
Integer |
是 |
流程渠道:0-流程,1-企业市场 |
|
processDetailId |
Long |
是 |
流程详情id |
|
executeType |
Integer |
是 |
执行类型:1-手动执行 2-立即执行 9-定时器执行 |
|
executeTimes |
Integer |
是 |
执行次数 |
|
maxQueueWait |
Integer |
是 |
最大等待时长,单位:分 |
|
maxQueueNumber |
Integer |
是 |
最大队列数 |
|
distributionType |
Integer |
是 |
分配类型 1-自动分配 2-指定bot机器人 |
|
priority |
Integer |
是 |
优先级 1~10,数值越小优先级越高,数值越大优先级越低 |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"jobId": "1501464045826420738" // 任务id
}
}
1.2 立即执行,指定机器人
{
"jobName": "绯世任务006", // 任务名称
"jobToProcessAddList": [
{
"processChannel": 0, // 流程渠道:0-流程,1-企业市场
"processDetailId": "1486230070408056833" //流程详情id
}
],
"executeType": 2, // 执行类型 1-手动执行 2-立即执行 9-定时器执行
"executeTimes": 1, // 执行次数
"maxQueueWait": 180000, // 最大等待时长,单位:分
"maxQueueNumber": 30, // 最大队列数
"distributionType": 2, // 分配类型 1-自动分配 2-指定bot机器人
"jobToBotAddList": [
{
"botId": "12345", // 机器人id
"priority": 5 //优先级 1~10 数值越小优先级越高,数值越大优先级越低
}
]
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
jobName |
String |
是 |
任务名称 |
|
jobToProcessAddList |
Object[] |
是 |
任务与流程数组 |
|
processChannel |
Integer |
是 |
流程渠道:0-流程,1-企业市场 |
|
processDetailId |
Long |
是 |
流程详情id |
|
executeType |
Integer |
是 |
执行类型:1-手动执行 2-立即执行 9-定时器执行 |
|
executeTimes |
Integer |
是 |
执行次数 |
|
maxQueueWait |
Integer |
是 |
最大等待时长,单位:分 |
|
maxQueueNumber |
Integer |
是 |
最大队列数 |
|
distributionType |
Integer |
是 |
分配类型 1-自动分配 2-指定bot机器人 |
|
jobToBotAddList |
Object[] |
是 |
任务与机器人数据 |
|
botId |
Long |
是 |
机器人id |
|
priority |
Integer |
是 |
优先级 1~10 数值越小优先级越高,数值越大优先级越低 |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"jobId": "1501464045826420738" // 任务id
}
}
1.3 定时执行、动态分配
{
"jobName": "手机端绯世任务005", // 任务名称
"jobToProcessAddList": [
{
"processChannel": 0, // 流程渠道:0-流程,1-企业市场
"processDetailId": "1486154013735305218" //流程详情id
}
],
"executeType": 9, // 执行类型 1-手动执行 2-立即执行 9-定时器执行
"executeTimes": 1, // 执行次数
"maxQueueWait": 180000, // 最大等待时长,单位:分
"maxQueueNumber": 30, // 最大队列数
"cronExpression": "0 0 */1 * * ?", // cron表达式
"isCheckActive": false, // 是否存在有效期:false-不存在,true-存在
"scheduleType": 3, // 调度类型 1 分钟,2 定时,3 小时,4 每天 ,5 每周,6 每月 0高级
"distributionType": 1, // 分配类型 1-自动分配 2-指定bot机器人
"priority": 5 //优先级 1~10 数值越小优先级越高,数值越大优先级越低
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
jobName |
String |
是 |
任务名称 |
|
jobToProcessAddList |
Object[] |
是 |
任务与流程数组 |
|
processChannel |
Integer |
是 |
流程渠道:0-流程,1-企业市场 |
|
processDetailId |
Long |
是 |
流程详情id |
|
executeType |
Integer |
是 |
执行类型:1-手动执行 2-立即执行 9-定时器执行 |
|
executeTimes |
Integer |
是 |
执行次数 |
|
maxQueueWait |
Integer |
是 |
最大等待时长,单位:分 |
|
maxQueueNumber |
Integer |
是 |
最大队列数 |
|
cronExpression |
String |
否 |
cron表达式,当scheduleType=1时,不用传递,使用fixTime代替 |
|
fixTime |
Long |
否 |
每隔多少分钟执行,当scheduleType=1,fixTime替换cronExpression |
|
isCheckActive |
Boolean |
是 |
是否存在有效期:false-不存在,true-存在 |
|
scheduleType |
Integer |
是 |
调度类型 1 分钟,2 定时,3 小时,4 每天 ,5 每周,6 每月 0高级 |
|
distributionType |
Integer |
是 |
分配类型 1-自动分配 2-指定bot机器人 |
|
priority |
Integer |
是 |
优先级 1~10,数值越小优先级越高,数值越大优先级越低 |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"jobId": "1501464045826420738" // 任务id
}
}
1.4 定时执行、指定机器人
{
"jobName": "手机端绯世任务004", // 任务名称
"jobToProcessAddList": [
{
"processChannel": 0, // 流程渠道:0-流程,1-企业市场
"processDetailId": "1486154013735305218" //流程详情id
}
],
"executeType": 9, // 执行类型 1-手动执行 2-立即执行 9-定时器执行
"executeTimes": 1, // 执行次数
"maxQueueWait": 180000, // 最大等待时长,单位:分
"maxQueueNumber": 30, // 最大队列数
"cronExpression": "0 0 */1 * * ?", // cron表达式
"isCheckActive": false, // 是否存在有效期:false-不存在,true-存在
"scheduleType": 3, // 调度类型 1 分钟,2 定时,3 小时,4 每天 ,5 每周,6 每月 0高级
"distributionType": 2, // 分配类型 1-自动分配 2-指定bot机器人
"jobToBotAddList": [
{
"botId": "12345", // 机器人id
"priority": 5 //优先级 1~10 数值越小优先级越高,数值越大优先级越低
}
]
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
jobName |
String |
是 |
任务名称 |
|
jobToProcessAddList |
Object[] |
是 |
任务与流程数组 |
|
processChannel |
Integer |
是 |
流程渠道:0-流程,1-企业市场 |
|
processDetailId |
Long |
是 |
流程详情id |
|
executeType |
Integer |
是 |
执行类型:1-手动执行 2-立即执行 9-定时器执行 |
|
executeTimes |
Integer |
是 |
执行次数 |
|
maxQueueWait |
Integer |
是 |
最大等待时长,单位:分 |
|
maxQueueNumber |
Integer |
是 |
最大队列数 |
|
cronExpression |
String |
否 |
cron表达式,当scheduleType=1时,不用传递,使用fixTime代替 |
|
fixTime |
Long |
否 |
每隔多少分钟执行,当scheduleType=1,fixTime替换cronExpression |
|
isCheckActive |
Boolean |
是 |
是否存在有效期:false-不存在,true-存在 |
|
scheduleType |
Integer |
是 |
调度类型 1 分钟,2 定时,3 小时,4 每天 ,5 每周,6 每月 0高级 |
|
distributionType |
Integer |
是 |
分配类型 1-自动分配 2-指定bot机器人 |
|
jobToBotAddList |
Object[] |
是 |
任务与机器人数据 |
|
botId |
Long |
是 |
机器人id |
|
priority |
Integer |
是 |
优先级 1~10 数值越小优先级越高,数值越大优先级越低 |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"jobId": "1501464045826420738" // 任务id
}
}
1.5 手动执行、指定机器人
{
"jobName": "手机端绯世任务007", // 任务名称
"jobToProcessAddList": [
{
"processChannel": 0, // 流程渠道:0-流程,1-企业市场
"processDetailId": "1486154013735305218" //流程详情id
}
],
"executeType": 1, // 执行类型 1-手动执行 2-立即执行 9-定时器执行
"maxQueueWait": 180000, // 最大等待时长,单位:分
"maxQueueNumber": 30, // 最大队列数
"distributionType": 2, // 分配类型 1-自动分配 2-指定bot机器人
"jobToBotAddList": [
{
"botId": "12345", // 机器人id
"priority": 5 //优先级 1~10 数值越小优先级越高,数值越大优先级越低
}
]
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
jobName |
String |
是 |
任务名称 |
|
jobToProcessAddList |
Object[] |
是 |
任务与流程数组 |
|
processChannel |
Integer |
是 |
流程渠道:0-流程,1-企业市场 |
|
processDetailId |
Long |
是 |
流程详情id |
|
executeType |
Integer |
是 |
执行类型:1-手动执行 2-立即执行 9-定时器执行 |
|
maxQueueWait |
Integer |
是 |
最大等待时长,单位:分 |
|
maxQueueNumber |
Integer |
是 |
最大队列数 |
|
distributionType |
Integer |
是 |
分配类型 1-自动分配 2-指定bot机器人 |
|
jobToBotAddList |
Object[] |
是 |
任务与机器人数据 |
|
botId |
Long |
是 |
机器人id |
|
priority |
Integer |
是 |
优先级 1~10 数值越小优先级越高,数值越大优先级越低 |
响应样例
{
"msg": "success",
"code": 0,
"data": {
"jobId": "1501464045826420738" // 任务id
}
}
二、手机端任务处理
接口说明
该接口是为了提供手机端任务管理功能,任务处理所使用的接口。
URL: https://z-commander-api.ai-indeed.com/openAPI/v1/mobile/job/operation
HTTP method: POST
Content-Type: application/json
请求样例
{
"jobId": 1501464045826420738, //任务id
"operationType": 3 // 操作类型
}
请求参数
|
参数 |
类型 |
必填 |
说明 |
|
jobId |
Long |
是 |
任务id |
|
operationType |
Integer |
是 |
操作类型:1-立即执行,2-停止,3-强制手动停止,4-删除 |
响应样例
{
"msg": "success",
"code": 0, // 0为成功
"data": true
}




