任务追加名单
服务描述
本接口,可用于外呼任务追加名单
以下任务状态可追加名单:未开始、进行中、已完成但任务结束大于当前时间
开发须知
调用本接口前,请先获取appId
服务地址
POST https://{您的专属域名}/speech/openapi/v1/task/outbound/customer/append
请求参数 - 自动外呼
参数 |
位置 |
类型 |
是否必填 |
说明 |
appId |
header |
String |
Y |
应用ID |
timestamp |
header |
String |
Y |
时间戳,毫秒 |
sign |
header |
String |
Y |
签名 |
Content-Type |
header |
String |
Y |
application/json |
taskId |
Body |
Number |
Y |
任务id |
outBoundCustomers |
Body |
List<OutBoundListFileVo> |
Y |
外呼名单,单次可添加1000个名单,可追加到2万 |
OutBoundListFileVo_Auto
参数 |
位置 |
类型 |
是否必填 |
说明 |
name |
Body |
Integer |
Y |
客户名称,长度限制:20 |
desc |
Body |
Integer |
N |
客户备注,长度限制:200 |
externalCustomerId |
Body |
String |
Y |
外部-客户id,租户方的客户id,长度限制:64 |
externalData |
Body |
String |
N |
透传数据,长度限制:40 |
phoneGroupVoList |
Body |
List<OutBoundTaskPhoneGroupCustomerVo> |
Y |
客户号码批次信息 |
OutBoundTaskPhoneGroupCustomerVo_Auto
OutBoundTaskPhoneRelationVo_Auto
参数 |
位置 |
类型 |
是否必填 |
说明 |
mobile |
Body |
String |
Y |
关系人号码 |
relation |
Body |
String |
N |
号码与客户的关系,如:父亲 |
请求参数 - 手动外呼
参数 |
位置 |
类型 |
是否必填 |
说明 |
appId |
header |
String |
Y |
应用ID |
timestamp |
header |
String |
Y |
时间戳,毫秒 |
sign |
header |
String |
Y |
签名 |
Content-Type |
header |
String |
Y |
application/json |
taskId |
Body |
Number |
Y |
任务id |
outBoundCustomers |
Body |
List<OutBoundListFileVo> |
Y |
外呼名单,单次可添加1000个名单,可追加到2万 |
taskAgents |
Body |
List<SpeechTaskAgentOpenDto> |
Y |
坐席分配列表 |
SpeechTaskAgentOpenDto_Maunal
参数 |
位置 |
类型 |
是否必填 |
说明 |
agentId |
Body |
Integer |
Y |
坐席id,通过根据技能组查询坐席获取 |
assignNum |
Body |
Integer |
Y |
分配客户数量 |
OutBoundListFileVo_Maunal
参数 |
位置 |
类型 |
是否必填 |
说明 |
name |
Body |
String |
Y |
客户名称,长度限制:20,特殊字符将被忽略:\n |
desc |
Body |
String |
N |
客户备注,长度限制:200,特殊字符将被忽略:\n |
externalCustomerId |
Body |
String |
Y |
外部-客户id,租户方的客户id,长度限制:64,特殊字符将被忽略:\n |
externalData |
Body |
String |
N |
租户透传数据,长度限制:40,特殊字符将被忽略:\n |
phoneGroupVoList |
Body |
List<OutBoundTaskPhoneGroupCustomerVo> |
Y |
客户号码批次信息 |
OutBoundTaskPhoneGroupCustomerVo_Maunal
OutBoundTaskPhoneRelationVo_Maunal
参数 |
位置 |
类型 |
是否必填 |
说明 |
mobile |
Body |
String |
Y |
关系人号码 |
relation |
Body |
String |
N |
号码与客户的关系,如:父亲 |
请求示例数据:
POST https://abc.xyz/speech/openapi/v1/task/outbound/customer/append
sign: fo1OWX+JnfeonAFSGau2gwP1GvFa+RTw5czoBWoz+k3AjV8scDl6JnvFRDj8Lgt1nQxLlmcOhIBN4j7pEE/NAzYjXUFSGo308f5V9dHBnmGLYsqKmgma4cQZLBqHp9T43IZfRX8Zh2/Hp2HOmfTgos/L8GN6YPA8fQ2d5tbtJZrrkBuwA/LEezjOJxSRRRCrcS1ZFVvTZ+cIjYeO4QdC5r5I67LLY/nLbFAFUdQsCzUIytO09vUCLGlKierNhPfCtMzTgZSE9dWO5zJ3L2uCsXM7Od6mPROVpddVafF+BueKjtbL10PwDc9f1eBpGTpgmbOy8Bbx3NIyCjDvhc9Mag==
appId: 99845aaaaebd4d61acccc9b776208f12
timestamp: 1586314097995
请求Body - 自动外呼:
{
"taskId": 689,
"outBoundCustomers": [
{
"name": "客户名称",
"desc": "客户描述",
"externalCustomerId":"1",
"externalData":"",
"phoneGroupVoList": [
{
"phoneGroupIdentify":"default",
"relations": [
{
"mobile":"13800000001",
"relation":"本人"
},
{
"mobile":"13800000002",
"relation":"妻子"
}
]
}
]
}
]
}
请求Body - 手动外呼:
{
"taskId": 686,
"taskAgents": [
{
"agentId": 19881338,
"assignNum": "1"
}
],
"outBoundCustomers": [
{
"name": "客户名称",
"desc": "客户描述",
"externalCustomerId":"1",
"externalData":"",
"phoneGroupVoList":[
{
"phoneGroupIdentify":"default",
"relations":[
{
"mobile":"13800000001",
"relation":"本人"
}
]
}
]
}
]
}
返回结果
参数 |
类型 |
说明 |
code |
String |
结果码 |
message |
String |
结果描述 |
data |
boolean |
true 操作成功,否则失败 |
返回结果示例:
{
"code": "10000",
"message": "请求成功",
"data": true
}
结果码说明
结果码 |
说明 |
10000 |
请求成功 |
10001 |
鉴权失败 |
10002 |
找不到对应的公钥,请先上传公钥 |
20001 |
请求失败 |
29002 |
参数错误 |
29008 |
系统异常 |