查看任务列表
更新时间：2024-04-26
URL
https://aiob-open.baidu.com/api/v3/console/apitask/task/list
https://aicc.bce.baidu.com/api/v3/console/apitask/task/list（即将下架）
HTTP Method
POST
请求参数
Header
| 参数名称 | 是否必须 | 说明 | 示例 |
|---|---|---|---|
| Content-Type | 是 | application/json | application/json |
| Authorization | 是 | 参考「生成认证Token」文档 | cc-api-auth-v1/5b050c050f5a4e74b8c20bf512e39c1d/2021-04-13T08:05:43Z/1800000/host;x-bce-date/746ed9ad706c379f31bafc292e3c720797e39bb7f08ce5f641d657e14e42dd33 |
Body
| 参数名称 | 类型 | 是否必须 | 说明 | 示例 |
|---|---|---|---|---|
| taskName | string | 否 | 任务名称 | "呼叫任务123_测试" |
| createStartTime | string | 否 | 任务创建开始时间，非必填，默认为全量，即不限制起始日期 | "2020-10-12" |
| createEndTime | string | 否 | 任务创建结束时间，非必填，任务创建时间（结束），精确到天，如2021-02-03，默认为当前日期 | "2020-10-12" |
| statusList | array | 否 | 任务状态 1:待启动，2：执行中，3：已暂停，4：已完成，默认为全部 | [1,2] |
| robotIdList | array | 否 | 机器人id，非必填，默认为全部机器人ID | ["2765019f-bef5-4f67-a3ac-1bd48db42e10"] |
| pn | int | 否 | 页码，非必填。默认1 | 1 |
| ps | int | 否 | 每页显示号码个数，非必填，默认20，最多不超过200条 | 20 |
响应参数
| 名称 | 类型 | 备注 |
|---|---|---|
| code | int | http响应码，比如200 |
| msg | string | 响应信息，成功为success，失败时为具体原因 |
| data | obj | 成功时为任务列表数据 |
data数据
| 名称 | 类型 | 备注 |
|---|---|---|
| pn | int | 当前页码 |
| ps | int | 当前页最大显示个数 |
| orderBy | string | 顺序规则 |
| order | string | 顺序/倒序 |
| total | int | 总个数 |
| list | array | 任务详情信息列表 |
list数据
| 名称 | 类型 | 备注 |
|---|---|---|
| taskId | string | 任务ID，任务唯一标识 |
| taskName | string | 任务名称 |
| finishNumCount | int | 任务中，已完成号码组个数 |
| totalNumCount | int | 任务中，号码组总数 |
| status | int | 任务状态， 1:待启动，2：执行中，3：已暂停，4：已完成 |
| reason | string | 任务原因 |
| robotId | string | 任务对应的外呼机器人id |
| robotName | string | 任务对应的外呼机器人名称 |
| taskStartTime | string | 任务开始时间 |
| taskEndTime | string | 任务结束时间 |
| createTime | string | 任务创建时间 |
请求示例
{
"taskName":"test_zjq_zpi_001", //任务名称，非必填
"createStartTime":"2021-05-01", // 任务创建开始时间，非必填，默认为全量，即不限制起始日期
"createEndTime":"2021-06-01", // 任务创建结束时间，非必填，任务创建时间（结束），精确到天，如2021-02-03，默认为当前日期
"statusList":[
1
], // 任务状态 1:待启动，2：执行中，3：已暂停，4：已完成
"robotIdList":[
"2765019f-bef5-4f67-a3ac-1bd48db42e10"
], // 机器人id，非必填，默认为全部机器人ID
"pn":1, //页码，非必填。默认1
"ps":20 // 每页显示号码个数，非必填，默认20，最多不超过200条
}返回结果
{
"code": 200,
"msg": "success",
"data": {
"pn": 1, //当前页码
"ps": 20,// 当前页最大显示个数
"orderBy": null,
"order": null,
"total": 1,// 总个数
"list": [
{
"taskId": "731346584781056", // 任务id
"taskName": "test_zjq_zpi_001", // 任务名称
"finishNumCount": 0, // 已完成号码组个数
"totalNumCount": 0, // 总号码组个数
"status": 1,// 任务状态 1:待启动，2：执行中，3：已暂停，4：已完成，如[1,2]，默认为全部
"reason": "", // 任务原因
"robotId": "2765019f-bef5-4f67-a3ac-1bd48db42e10", // 机器人id
"robotName": "",// 机器人名称
"taskStartTime": "2021-05-31 15:25:13",
"taskEndTime": "2021-05-31 15:28:13",
"createTime": "2021-05-31 15:24:13"//创建时间
}
]
}
}