批量查询任务拨打进度
此接口【v1.2.31版本有变动】 查看变更日志
方式一请求接口agent-api/batch/task_progress请求方式GET路由参数
参数 | 类型 | 示例 | 解释 | 必填 |
|---|---|---|---|---|
|
|
|
|
|
示例
//已废弃 { "task_ids":["2d731938-03af-4949-b318-9348217f1df","289b4a84-5648-4c92-8173-6addd8359d70"] //最多10个 }1plaintext
2
3
4返回结果
{//已废弃
"code": 200,
"status": "success",
"message": "批量获取任务进度成功",
"data": [
{
"task_id": "2d731938-03af-4949-b318-9348217f1df3",
"progress": {
"total": 54, //任务号码总数
"progress": 38, //已拨打号码数
"percent": 70 //百分比
}
},
{
"task_id": "289b4a84-5648-4c92-8173-6addd8359d70",
"progress": {
"total": 5,
"progress": 0,
"percent": 0
}
}
]
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
方式2
请求接口
/agent-api/user/{user_id}/batch/task_progress请求方式
GET参数
参数 | 类型 | 示例 | 解释 | 必填 |
|---|---|---|---|---|
user_id | string | ff33acc2-2e7b-46d6-8965-f3826d19bf40 | 用户id | 是 |
task_ids | array | ["2d731938-03af-4949-b318-9348217f1df","289b4a84-5648-4c92-8173-6addd8359d70"] | 任务id | 是 |
参数
类型
示例
解释
必填
user_id
string
ff33acc2-2e7b-46d6-8965-f3826d19bf40
用户id
是
task_ids
array
["2d731938-03af-4949-b318-9348217f1df","289b4a84-5648-4c92-8173-6addd8359d70"]
任务id
是
sub_user_id
string
ac756822-f385-4f7d-b221-26c7604b2ceb
子账户ID (传递此参数则是对子账户操作)
否
示例
{ "sub_user_id": "1f221144-630e-4d8e-a85e-d781e797cb96",//非必填 子账户ID (传递此参数则是对子账户操作) "task_ids":["289b4a84-5648-4c92-8173-6addd8359d70"] }1json
2
3
4返回参数
{ "code": 200, "status": "success", "message": "批量获取任务进度成功", "data": [ { "task_id": "2d731938-03af-4949-b318-9348217f1df3", "progress": { "total": 54, //任务号码总数 "progress": 38, //已拨打号码数 "percent": 70 //百分比 } } ] }1json
2
3
4
5
6
7
8
9
10
11
12
13
14
15此接口跟
方式1的接口区别在于，方式2的接口中传的参数task_ids中如果传了不存在的任务ID则会过滤掉不存在的任务，返回存在的任务的拨打进度，而
方式1的接口则会抛出错误，返回不存在的任务ID，不会返回任务的拨打进度。
