更新外呼名单元数据
服务描述
本接口,可根据某个特定任务,对任务中的名单的元数据信息修改。
开发须知
调用本接口前,请先获取appId
服务地址
POST https://{您的专属域名}/outbound/openapi/v2/task/updateMetadata
请求参数
参数 |
位置 |
类型 |
是否必填 |
说明 |
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 |
BatchUpdateMetadataRequest |
Y |
名单列表信息,json array |
参数 |
类型 |
是否必填 |
说明 |
taskCode |
String(32) |
Y |
任务编码 |
List |
List |
Y |
需要修改元数据的名单信息,最大支持2000条数据,并确保外呼名单编码唯一 |
参数 |
类型 |
是否必填 |
说明 |
audioRecordCode |
String(32) |
Y |
外呼名单编码或外部名单code |
extendInfos |
String(1000) |
Y |
json串,为空时传:{}; 格式:{ "xxx": "", "zzz": 111}扩展信息,存储机器人话术变量,业务字段,透传参数等 |
加密,encrypted
传值,表示需要加密,按照以下步骤加密传输
将json数据加解密工具加密后,通过body传到接口
Body数据示例:
- 需要加密,以下是入参加密前的json
- 不需要加密则直接传Json参数到body
{
"taskCode": "e9a0edb5e839eada14624f83df4c4dd0",
"list": [
{
"audioRecordCode": "a492e8f048d00bcc723d62719e245546",
"extendInfos": {
"授信额度": "3000",
"银行卡": "123"
}
},
{
"audioRecordCode": "a492e8f048d00bcc723d62719e245502",
" extendInfos ": {
"授信额度": "5000",
"银行卡": "234"
}
}
]
}
返回结果加密
加密方式header
中的encrypted
传值,表示需要对返回结果进行加密,拿到加密后的返回结果,
使用私钥加解密工具进行解密
返回结果
- 需要加密,以下是返回结果加密前的json
- 不需要加密则直接直接返回不加密的结果
参数 |
类型 |
说明 |
code |
String |
结果码 |
message |
String |
结果描述 |
data |
List |
对应名单的处理结果信息 json array |
参数 |
类型 |
说明 |
audioRecordCode |
String(32) |
外呼名单编码,长度32位 |
status |
integer(1) |
修改结果,1修改成功 0修改失败 |
msg |
String(64) |
提示信息 |
返回结果示例:
{
"code": "10000",
"message": "请求成功",
"data": [{
"status": "1",
"msg": "修改成功",
"audioRecordCode": "a492e8f048d00bcc723d62719e245546"
},
{
"status": "0",
"msg": "该名单已送号,不支持修改",
"audioRecordCode": "a492e8f048d00bcc723d62719e245502"
}]
}
结果码说明
结果码 |
说明 |
10000 |
请求成功 |
20001 |
请求失败 |
21002 |
认证失败,请重新登录 |
FAQ: