创建自动外呼任务
服务描述
本接口,可用于创建云呼叫中心自动外呼任务
开发须知
调用本接口前,请先获取appId
服务地址
POST https://{您的专属域名}/speech/openapi/v1/task/outbound/create
请求参数
参数 |
位置 |
类型 |
是否必填 |
说明 |
appId |
header |
String |
Y |
应用ID |
timestamp |
header |
String |
Y |
时间戳,毫秒 |
sign |
header |
String |
Y |
签名 |
Content-Type |
header |
String |
Y |
application/json |
taskName |
Body |
String |
Y |
任务名称(不能重复),长度:1至50 |
taskType |
Body |
Integer |
Y |
任务类型(1-自动外呼,2-手动外呼) |
taskExecStartDate |
Body |
String |
Y |
任务开始时间(yyyy-MM-dd) |
taskExecEndDate |
Body |
String |
Y |
任务结束时间(yyyy-MM-dd) |
taskExecTimes |
Body |
List<ExecTimeOpenDto> |
Y |
任务拨打时间段 |
taskDesc |
Body |
String |
N |
任务描述 |
skillSetId |
Body |
String |
Y |
技能组id,通过接口呼出技能组获取 |
outboundNumberGroupId |
Body |
String |
Y |
外呼号码组id,通过接口外呼号码组获取 |
strategyDisplaySwitch |
Body |
Boolean |
Y |
策略外显开关 true-开启 false-关闭,默认:关闭 |
sendNumberStrategy |
Body |
Integer |
Y |
送号策略(0-按倍率值计算 ; 1-预测式外呼) |
multiplyPower |
Body |
Integer |
送号策略=0:Y |
倍率值,范围:大于0 |
abandonmentRate |
Body |
Integer |
送号策略=1:Y |
放弃率,范围:1 至 5 |
maxRingingDuration |
Body |
Integer |
Y |
最大振铃时间(最小值20s,最大值50s,默认45s) |
acw |
Body |
Integer |
Y |
话后时长(1s-180s,默认10s) |
outboundPhoneGroups |
Body |
List<PhoneGroupDto> |
Y |
号码批次,目前只支持1个号码组 |
outBoundCustomers |
Body |
List<CustomerDto> |
Y |
外呼名单,单次可添加1000个名单,可追加到2万 |
ExecTimeOpenDto
参数 |
位置 |
类型 |
是否必填 |
说明 |
taskExecTimeStartStr |
Body |
String |
Y |
任务执行开始时间,格式:HH:mm:ss |
taskExecTimeEndStr |
Body |
String |
Y |
任务执行结束时间,格式:HH:mm:ss |
PhoneGroupDto
参数 |
位置 |
类型 |
是否必填 |
说明 |
name |
Body |
String |
Y |
号码批次名称 |
identify |
Body |
String |
Y |
号码批次标识 |
autoOutboundSwitch |
Body |
Integer |
Y |
重呼设置开关(0-关闭;1-开启,默认0) |
autoOutboundInterval |
Body |
Integer |
自动重呼开启:Y |
重呼间隔(分钟),范围:5 至 2880 |
autoOutboundTimes |
Body |
Integer |
自动重呼开启:Y |
重呼次数,范围:1 至 3 |
CustomerDto
参数 |
位置 |
类型 |
是否必填 |
说明 |
name |
Body |
String |
Y |
客户名称,长度限制:20 |
desc |
Body |
String |
N |
客户备注,长度限制:200 |
externalCustomerId |
Body |
String |
Y |
外部-客户id,租户方的客户id,长度限制:64 |
externalData |
Body |
String |
N |
透传数据,长度限制:40 |
phoneGroupVoList |
Body |
List<PhoneGroupCustomerDto> |
Y |
客户号码批次信息 |
PhoneGroupCustomerDto
参数 |
位置 |
类型 |
是否必填 |
说明 |
phoneGroupIdentify |
Body |
String |
Y |
号码批次 - 标识,必须与“号码批次标识一致” |
relations |
Body |
List<PhoneRelatioDto> |
Y |
关系人,第一个关系人必须为客户本人,支持3个号码 |
PhoneRelationDto
参数 |
位置 |
类型 |
是否必填 |
说明 |
mobile |
Body |
String |
Y |
关系人号码 |
relation |
Body |
String |
N |
号码与客户的关系,如:父亲 |
请求示例数据:
POST https://abc.xyz/speech/openapi/v1/task/outbound/create
sign: fo1OWX+JnfeonAFSGau2gwP1GvFa+RTw5czoBWoz+k3AjV8scDl6JnvFRDj8Lgt1nQxLlmcOhIBN4j7pEE/NAzYjXUFSGo308f5V9dHBnmGLYsqKmgma4cQZLBqHp9T43IZfRX8Zh2/Hp2HOmfTgos/L8GN6YPA8fQ2d5tbtJZrrkBuwA/LEezjOJxSRRRCrcS1ZFVvTZ+cIjYeO4QdC5r5I67LLY/nLbFAFUdQsCzUIytO09vUCLGlKierNhPfCtMzTgZSE9dWO5zJ3L2uCsXM7Od6mPROVpddVafF+BueKjtbL10PwDc9f1eBpGTpgmbOy8Bbx3NIyCjDvhc9Mag==
appId: 99845aaaaebd4d61acccc9b776208f12
timestamp: 1586314097995
请求Body:
{
"taskName": "自动外呼任务名称",
"taskType": 1,
"taskExecStartDate": "2020-09-27",
"taskExecEndDate": "2020-09-27",
"taskExecTimes": [
{
"taskExecTimeStartStr": "11:36:00",
"taskExecTimeEndStr": "12:35:00"
}
],
"taskDesc": "自动外呼描述",
"skillSetId": "1462016331580064",
"outboundNumberGroupId": "1070678044124225",
"strategyDisplaySwitch":1,
"sendNumberStrategy": 0,
"abandonmentRate": 2,
"multiplyPower": 2,
"maxRingingDuration": 20,
"acw": 10,
"outboundPhoneGroups":[
{
"name":"外呼任务号码批次名称,如:本人、亲属、朋友",
"identify":"default",
"autoOutboundSwitch": 1,
"autoOutboundInterval": 5,
"autoOutboundTimes": 1
}
],
"outBoundCustomers": [
{
"name": "客户名称",
"desc": "客户描述",
"externalCustomerId":"1",
"externalData":"",
"phoneGroupVoList":[
{
"phoneGroupIdentify":"default",
"relations":[
{
"mobile":"13800000001",
"relation":"本人"
}
]
}
]
}
]
}
返回结果
参数 |
类型 |
说明 |
code |
String |
结果码 |
message |
String |
结果描述 |
data |
Long |
任务id |
CommunicateBaseVo
返回结果示例:
{
"code": "10000",
"message": "请求成功",
"data": 123
}
结果码说明
结果码 |
说明 |
10000 |
请求成功 |
10001 |
鉴权失败 |
10002 |
找不到对应的公钥,请先上传公钥 |
20001 |
请求失败 |
29002 |
参数错误 |
29008 |
系统异常 |