Callbot API batchImportCall - nxtele/http-api-document GitHub Wiki
callbot-api
v1.0.0
Base URLs:
aibot外部接口v3.0/订单操作
鉴权方式
鉴权请查看文档https://github.com/nxtele/http-api-document/wiki/Callbot-API-authorization
POST 批次-添加通话订单
POST /callcentre/api/v3/importBatchCall
导入最新批次的号码
返回响应码枚举值
返回响应码 | 错误原因 |
---|---|
0 | 成功 |
1 | 通用错误 |
2 | 参数丢失 |
3 | 参数格式错误 |
4 | 参数值错误 |
4001 | 参数内容容量错误(数组元素过多) |
5 | 服务器维护 |
5001 | 服务器内部错误 |
6 | 签名不正确 |
6001 | 签名错误丢失 |
6001 | 签名错误丢失 |
6002 | 账号不存在 |
6003 | 用户没有权限 |
7 | 系统正忙 |
1001 | 批次导入进行中,不可导入导出 |
Body 请求参数
{
"productID": "callbot",
"userTaskID": "string",
"callInfoList": {
"orderCallbackUrl": "string",
"callCallbackUrl": "string",
"callList": [
{
"orderID": "string",
"userPhone": "string",
"other": "string",
"userName": "string",
"customerName": "string",
"params": [
{
"name": null,
"value": null
}
]
}
]
}
}
请求参数
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
requestID | header | string | 是 | 请求唯一id |
uuid | header | string | 是 | uuid,由被调用方给出 |
createTs | header | string | 是 | 请求时间戳,(秒级) |
sign | header | string | 是 | 签名 |
algorithm | header | string | 否 | 签名的算法:MD5或者SHA256,不填默认用MD5 |
Content-Encoding | header | string | 否 | 如果填了gzip,则会对请求体进行解压 |
body | body | object | 否 | none |
» productID | body | string | 是 | 定值"callbot" |
» userTaskID | body | string | 是 | 请求方的任务id(调用方生成并且保证唯一),建议使用uuid |
» callInfoList | body | object | 是 | none |
»» orderCallbackUrl | body | string | 是 | 通话订单完成后回调地址 |
»» callCallbackUrl | body | string | 是 | 通话完成后回调地址 |
»» callList | body | [object] | 是 | 一个号码即为一个订单,一个订单会进行一轮或多轮通话 |
»»» orderID | body | string | 是 | 调用方生成,并保证全局唯一,建议使用uuid, |
»»» userPhone | body | string | 是 | 带有用户手机区号,不带符号,如 86156xxxxxxxx |
»»» other | body | string | 是 | none |
»»» userName | body | string | 是 | 可以为空字符串 |
»»» customerName | body | string | 是 | 可以为空字符串 |
»»» params | body | [object] | 是 | 如话术模板中含有变量,则需填入所有变量,可通过话术管理->变量设置 查询模板名,并按照变量类型规定,输入对应的字符串值 |
»»»» name | body | string | 是 | none |
»»»» value | body | string | 是 | none |
返回示例
200 Response
{
"retCode": 0,
"retMsg": "string",
"responseID": "string",
"totalCount": 0,
"successCount": 0,
"errList": [
{
"phone": "string",
"errMsg": "string"
}
]
}
返回结果
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
响应的header
名称 | 类型 | 必选 | 说明 |
---|---|---|---|
requestID | string | 是 | 与请求头一致 |
uuid | string | 是 | 与请求头一致 |
createTs | string | 是 | 响应时的秒级时间戳 |
sign | string | 是 | 生成方法与请求头sign生成算法一样 |
algorithm | string | 否 | 与请求头一致,签名的算法:MD5或者SHA256,不填默认用MD5 |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 说明 |
---|---|---|---|---|
» retCode | integer | true | none | 响应码,0为成功,其余为失败 |
» retMsg | string | true | none | 响应消息 |
» responseID | string | true | none | 响应id,随机唯一id,用于请求追踪,定位问题时需要提供该次请求的responseID |
» totalCount | integer | true | none | 导入总数 |
» successCount | integer | true | none | 导入成功数 |
» errList | [object] | false | none | 错误列表 |
»» phone | string | true | none | 导入失败手机号 |
»» errMsg | string | true | none | 导入失败原因 |