一键外呼
服务描述
本接口,可根据某个特定任务,添加名单,进行外呼。 注意事项:已完成的任务,调用此接口追加名单后,会自动开始外呼。 任务未开始或任务暂停,需要调用启动外呼任务接口;如果是定时任务,也可以等待任务自动启动,这对时间要求很高,建议调用启动外呼任务接口。
开发须知
调用本接口前,请先获取appId
服务地址
POST https://{您的专属域名}/outbound/openapi/v2/task/directCall
请求参数
参数 | 位置 | 类型 | 是否必填 | 说明 |
---|---|---|---|---|
appId | header | String | Y | 应用ID |
timestamp | header | String | Y | 时间戳,毫秒 |
sign | header | String | Y | 签名 |
encrypted | header | String | N | 是否需要加密,需要加密传值(加密方式):AES/REQBODY/RESP,不需要加密不用传该字段 |
Content-Type | header | String | Y | application/json |
Body | OpenBatchCallListRequest | Y | 批量外呼信息,json |
OpenBatchCallListRequest
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
taskCode | String(32) | Y | 任务编码 |
List |
List | Y | 名单信息,最大支持2000条数据,并确保名单手机号唯一 |
OpenCallListDTO
参数 | 类型 | 是否必填 | 说明 |
---|---|---|---|
name | String(20) | Y | 姓名 |
phoneNumber | String(11) | Y | 手机号 |
extendInfos | String(1000) | N | json串,格式:{ "xxx": "", "zzz": 111}扩展信息,存储机器人话术变量,业务字段,透传参数等 |
callbackUrl | String(255) | N | 回调地址,接收方(接口使用者)通过参数callbackResult接收回调结果 |
audioRecordCode | String(64) | N | 外部客户名单code,传入了需要修改名单元数据或移除名单,需通过该code。不传会生成默认的唯一外呼名单code |
加密,encrypted
传值,表示需要加密,按照以下步骤加密传输
将json数据加解密工具加密后,通过body传到接口
Body数据示例:
- 需要加密,以下是入参加密前的json
- 不需要加密则直接传Json参数到body
{
"taskCode": "e9a0edb5e839eada14624f83df4c4dd0",
"list": [
{
"name": "张三",
"extendInfos": {
"授信额度": "3000",
"银行卡": "123"
},
"phoneNumber": "13540316580",
"callbackUrl": "http://xxxx.com/callback"
},
{
"name": "李四",
" extendInfos ": {
"授信额度": "5000",
"银行卡": "234"
},
"phoneNumber": "18840316580",
"callbackUrl": "http://xxxx.com/callback"
}
]
}
传入外部名单code示例:
{
"taskCode": "53623dd03d9fde5b92daa6c656b79471",
"list": [
{
"name": "x先生",
"extendInfos": {
"用户姓名": "x先生"
},
"phoneNumber": "18840316580",
"callbackUrl": "http://xxxx.com/callback",
"audioRecordCode":"abc1234567"
}
]
}
返回结果加密
加密方式
header
中的encrypted
传值,表示需要对返回结果进行加密,拿到加密后的返回结果, 使用私钥加解密工具进行解密
返回结果
- 需要加密,以下是返回结果加密前的json
- 不需要加密则直接直接返回不加密的结果
参数 | 类型 | 说明 |
---|---|---|
code | String | 结果码 |
message | String | 结果描述 |
data | List |
名单信息 |
OpenBatchCallListResponse
参数 | 类型 | 说明 |
---|---|---|
name | String(20) | 姓名 |
phoneNumber | String(11) | 手机号 |
audioRecordCode | String(32) | 外呼名单编码,长度32位或外部客户号 |
返回结果示例:
{
"code": "10000",
"message": "请求成功",
"data": [{
"name": "张三",
"phoneNumber": "13540316580",
"audioRecordCode": "a492e8f048d00bcc723d62719e245546"
},
{
"name": "李四",
"phoneNumber": "18840316580",
"audioRecordCode": "a492e8f04qq23bcc723d62719e245546"
}]
}
结果码说明
结果码 | 说明 |
---|---|
10000 | 请求成功 |
20001 | 请求失败 |
21002 | 认证失败,请重新登录 |