查询任务列表
服务描述
本接口,可用于外呼任务列表查询
开发须知
调用本接口前,请先获取appId
服务地址
GET https://{您的专属域名}/speech/openapi/v1/task/outbound/page
请求参数
参数 |
位置 |
类型 |
是否必填 |
说明 |
appId |
header |
String |
Y |
应用ID |
timestamp |
header |
String |
Y |
时间戳,毫秒 |
sign |
header |
String |
Y |
签名 |
Content-Type |
header |
String |
Y |
application/json |
query |
Query |
String |
N |
任务名称 |
taskType |
Query |
Number |
N |
任务类型,0-全部,1-自动外呼,2-手动外呼 |
taskStatus |
Query |
Number |
N |
任务状态 1:未开始,2:已暂停,3:进行中,4.已完成,5.已过期,6.任务执行异常 |
skillsetId |
Query |
Number |
N |
技能组 |
pageNum |
Query |
Number |
N |
第几页,默认1 |
pageSize |
Query |
Number |
N |
每页数量,默认20 |
请求示例数据:
GET https://abc.xyz/speech/openapi/v1/task/outbound/page
sign: fo1OWX+JnfeonAFSGau2gwP1GvFa+RTw5czoBWoz+k3AjV8scDl6JnvFRDj8Lgt1nQxLlmcOhIBN4j7pEE/NAzYjXUFSGo308f5V9dHBnmGLYsqKmgma4cQZLBqHp9T43IZfRX8Zh2/Hp2HOmfTgos/L8GN6YPA8fQ2d5tbtJZrrkBuwA/LEezjOJxSRRRCrcS1ZFVvTZ+cIjYeO4QdC5r5I67LLY/nLbFAFUdQsCzUIytO09vUCLGlKierNhPfCtMzTgZSE9dWO5zJ3L2uCsXM7Od6mPROVpddVafF+BueKjtbL10PwDc9f1eBpGTpgmbOy8Bbx3NIyCjDvhc9Mag==
appId: 99845aaaaebd4d61acccc9b776208f12
timestamp: 1586314097995
pageNumber: 1
pageSize: 20
返回结果
参数 |
类型 |
说明 |
code |
String |
结果码 |
message |
String |
结果描述 |
data |
PageInfo |
任务数据集合 |
PageInfo
参数 |
类型 |
说明 |
total |
Number |
数据总数 |
list |
TaskInfo |
任务数据 |
TaskInfo
参数 |
类型 |
说明 |
taskId |
Number |
任务id |
taskName |
String |
任务名称 |
taskType |
Integer |
任务类型(1自动外呼,2手动外呼) |
taskStatus |
Integer |
任务状态(1:未开始,2:已暂停,3:进行中,4.已完成,5.已过期,6.任务执行异常) |
taskExecStartDate |
String |
任务开始时间(YYYY-MM-DD) |
taskExecEndDate |
String |
任务结束时间(YYYY-MM-DD) |
taskExecTimes |
List<SpeechTaskExecTimeOpenDto> |
任务拨打时间段,自动外呼时有值 |
taskDesc |
String |
任务描述 |
skillSetId |
String |
技能组id,通过接口外呼技能组获取 |
skillSetName |
String |
技能组名称 |
outboundNumberGroupId |
String |
外呼号码组id,自动外呼时有值,通过接口外呼号码组获取 |
strategyDisplaySwitch |
Boolean |
策略外显开关(true:开启,false:关闭),自动外呼时有值 |
sendNumberStrategy |
Integer |
送号策略(0、按倍率值计算 ; 1、预测式外呼),自动外呼时有值 |
multiplyPower |
Integer |
倍率值,送号策略=0时必填 |
abandonmentRate |
Integer |
放弃率,送号策略=1时必填 |
maxRingingDuration |
Integer |
最大振铃时间(最小值20s,最大值50s,默认45s),自动外呼时有值 |
acw |
Integer |
话后时长(1s-180s,默认10s),自动外呼时有值 |
outboundPhoneGroups |
List<OutBoundTaskPhoneGroupVo> |
话后时长(1s-180s,默认10s) |
taskAgents |
List<SpeechTaskAgentOpenDto> |
坐席分配客户数量,手动外呼时有值 |
customerAmount |
int |
名单总数 |
completedCount |
int |
完成名单数量 |
connectedCount |
int |
已接通名单数量 |
connectPercentage |
String |
接通率(百分比) |
taskProgress |
String |
任务进度(百分比) |
SpeechTaskExecTimeOpenDto
参数 |
类型 |
说明 |
taskExecTimeStartStr |
String |
任务执行开始时间,格式:HH:mm:ss |
taskExecTimeEndStr |
String |
任务执行结束时间,格式:HH:mm:ss |
OutBoundTaskPhoneGroupVo
参数 |
类型 |
说明 |
name |
String |
号码组名称 |
identify |
String |
号码组-标识 |
autoOutboundSwitch |
Integer |
自动外呼- 自动重呼设置开关 1-开启 0-关闭 |
autoOutboundInterval |
Integer |
自动外呼- 自动重呼间隔时间(分钟) |
autoOutboundTimes |
Integer |
自动外呼- 自动重呼次数 |
SpeechTaskAgentOpenDto
参数 |
类型 |
说明 |
agentId |
Integer |
坐席id |
assignNum |
Integer |
分配客户数量 |
返回结果示例:
{
"code": "10000",
"message": "请求成功",
"data": {
"total": 1,
"list": [
{
"taskId": 1618,
"taskName": "autotest050",
"taskType": 1,
"taskStatus": 3,
"taskExecStartDate": "2020-09-20",
"taskExecEndDate": "2020-10-30",
"taskExecTimes": [
{
"taskExecTimeStartStr": "11:36:00",
"taskExecTimeEndStr": "21:35:00"
}
],
"taskDesc": "自动外呼",
"skillSetId": "1495152791910144",
"outboundNumberGroupId": "1070678044124425",
"strategyDisplaySwitch": true,
"sendNumberStrategy": 0,
"abandonmentRate": 1,
"multiplyPower": 1,
"maxRingingDuration": 20,
"acw": 10,
"taskAgents": null,
"outboundPhoneGroups": [
{
"name": "1",
"identify": "default",
"autoOutboundSwitch": 1,
"autoOutboundInterval": 5,
"autoOutboundTimes": 1
}
],
"customerAmount": 10,
"completedCount": 10,
"connectedCount": 5,
"connectPercentage": "50.00%",
"taskProgress": "100.00%"
}
]
}
}
结果码说明
结果码 |
说明 |
10000 |
请求成功 |
10001 |
鉴权失败 |
10002 |
找不到对应的公钥,请先上传公钥 |
20001 |
请求失败 |
29002 |
参数错误 |
29008 |
系统异常 |