导入名单
更新时间：2024-04-26
URL
https://aiob-open.baidu.com/api/v3/console/apitask/import
https://aicc.bce.baidu.com/api/v3/console/apitask/import（即将下架）
HTTP Method
POST
请求参数
Header
| 参数名称 | 是否必须 | 说明 | 示例 |
|---|---|---|---|
| Content-Type | 是 | application/json | application/json |
| Authorization | 是 | 参考「生成认证Token」文档 | cc-api-auth-v1/5b050c050f5a4e74b8c20bf512e39c1d/2021-04-13T08:05:43Z/1800000/host;x-bce-date/746ed9ad706c379f31bafc292e3c720797e39bb7f08ce5f641d657e14e42dd33 |
Body
| 参数名称 | 类型 | 是否必须 | 说明 | 示例 |
|---|---|---|---|---|
| taskId | string | 是 | 目标任务ID | "734100795851008" |
| secretType | int | 是 | 加密类型， 1：系统加密，即被叫号码采用系统的加密方式，AES128加密；2：不加密，即被叫号码为明文；3：自定义加密，即被叫号码采用客户自定义的加密方式，需在配置台-隐私配置-其他配置中配置自定义加解密服务地址，便于请求解密 | 1 |
| secretId | int | 否 | 密钥ID，加密类型为系统加密时，必填 | 3223348 |
| plainText | string | 是 | 明文, 字符串，长度小于等于20, 如果加密类型为系统加密，则必填 | 1333300330 |
| cipherText | string | 是 | 密文，字符串，加密类型为系统加密时，必填 | 0F2B2FA20AE886B10291FC5D46131765 |
| customerInfoList | array | 是 | 客户名单list | 说明：每一次最多只能导入1000个号码组，可以多次导入同一个任务 |
customerInfoList数据
| 参数名称 | 类型 | 是否必须 | 说明 | 示例 |
|---|---|---|---|---|
| extJson | string | 是 | 调用方的业务随路数据, 字符串，百度侧原文回传 | dddd |
| mobile | string | 是 | 号码1;号码2;号码3, 最多5个号码，英文分号分隔,支持明文或密文 | 791F60765EA9423B54FD8F93B512827A;0F2B2FA20AE886B10291FC5D46131765;EA8DB0E7325F888D2DDF52D7E8D5F20D; |
| address | string | 否 | 用户指定归属地，为空则默认使用号码实际归属地，实际行政区域即可无格式要求，"-"分隔开即可 | 如北京:北京-北京 北京市-北京市 北京市-市辖区-昌平区 北京市-市辖区 均可匹配到北京主叫号码 再如 河北省保定市定州市：河北-保定 河北省-保定市-定州市 均可匹配到保定主叫号码 不要只写最细粒度地址 |
| var | obj | 是 | 名单的变量var map，名单外呼时需要用到的变量 | {"key1": "value1","key2": "value2"} |
响应参数
| 名称 | 类型 | 备注 |
|---|---|---|
| code | int | http响应码，比如200 |
| msg | string | 响应信息，成功为success，失败时为具体原因 |
| data | obj | 成功时为导入名单明细 |
data数据
| 名称 | 类型 | 备注 |
|---|---|---|
| successNum | int | 名单导入成功条数 |
| failedNum | int | 名单导入失败条数 |
| resList | obj | 导入明细 |
resList数据
| 名称 | 类型 | 备注 |
|---|---|---|
| status | boolean | 导入的状态，true为 成功 bool |
| extJson | string | 调用方的业务随路数据, 字符串，百度侧原文回传 |
| reason | string | 失败原因 |
| taskMemberId | long | 百度侧memberID，用户 用户号码组详情查询 |
请求示例
{
"taskId": 734100795851008, // 目标任务ID，必填
"secretType": 1, //加密类型， 1：系统加密，即被叫号码采用系统的加密方式，AES128加密；2：不加密，即被叫号码为明文；3：自定义加密，即被叫号码采用客户自定义的加密方式，需在配置台-隐私配置-其他配置中配置自定义加解密服务地址，便于请求解密，必填
"secretId": 2, //密钥ID，加密类型为系统加密时，必填
"plainText": "13333003300", //明文, 字符串，长度小于等于20, 如果加密类型为系统加密，则必填
"cipherText": "0F2B2FA20AE886B10291FC5D46131765" // 密文，字符串，加密类型为系统加密时，必填
"customerInfoList": [ //客户名单list
{
"extJson": "", //调用方的业务随路数据, 字符串，百度侧原文回传
"mobile": "791F60765EA9423B54FD8F93B512827A;0F2B2FA20AE886B10291FC5D46131765;EA8DB0E7325F888D2DDF52D7E8D5F20D;9D7C836F976B6DF99BF7BF4C5DD9BF37;781CD5A78108B175A8DCE8196F0160C4", // 号码1;号码2;号码3;号码4;号码5, 最多5个号码，英文分号分隔。，必填
"var": { // 名单的变量var map，非必填
"key1": "value1",
"key2": "value2"
}
},
{
"extJson": "",//调用方的业务随路数据, 字符串，百度侧原文回传
"mobile": "791F60765EA9423B54FD8F93B512827A;0F2B2FA20AE886B10291FC5D46131765;EA8DB0E7325F888D2DDF52D7E8D5F20D;9D7C836F976B6DF99BF7BF4C5DD9BF37;781CD5A78108B175A8DCE8196F0160C4",
"var": {
"key1": "value1",
"key2": "value2"
}
}
],
}返回示例
{
"code": 200,
"msg": "success",
"data": {
"successNum": 2, // 名单导入成功条数
"failedNum": 0, // 名单导入失败条数
"resList": [ // 导入明细
{
"status": true, // 导入的状态，true为 成功 bool
"extJson": "",//调用方的业务随路数据, 字符串，百度侧原文回传
"reason": null, // 失败原因
"taskMemberId": 734116037099777 // 百度侧memberID，用户 用户号码组详情查询
},
{
"status": true,
"extJson": "",//调用方的业务随路数据, 字符串，百度侧原文回传
"reason": null,
"taskMemberId": 734116037116160
}
]
}
}