Callbot API batchExportCall - 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/exportBatchCall
返回响应码枚举值
返回响应码 | 错误原因 |
---|---|
0 | 成功 |
1 | 通用错误 |
2 | 参数丢失 |
3 | 参数格式错误 |
4 | 参数值错误 |
4001 | 参数内容容量错误(数组元素过多) |
5 | 服务器维护 |
5001 | 服务器内部错误 |
6 | 签名不正确 |
6001 | 签名错误丢失 |
6001 | 签名错误丢失 |
6002 | 账号不存在 |
6003 | 用户没有权限 |
7 | 系统正忙 |
1001 | 批次导入进行中,不可导入导出 |
Body 请求参数
{
"productID": "string",
"userTaskID": "string"
}
请求参数
名称 位置 类型 必选 说明 requestID header string 是 请求唯一id uuid header string 是 uuid,由被调用方给出 createTs header string 是 请求时间戳,(秒级) sign header string 是 签名 algorithm header string 否 签名的算法:MD5或者SHA256,不填默认用MD5 Accept-Encoding header string 否 如果填了gzip,那么响应体将会压缩返回 body body object 否 none » productID body string 是 定值"callbot" » userTaskID body string 是 请求方的任务id(调用方生成并且保证唯一),建议使用uuid 返回示例
200 Response
{
"retCode": 0,
"retMsg": "string",
"responseID": "string",
"totalCount": 0,
"batchID": "string",
"callList": [
{
"orderID": "string",
"userPhone": "string",
"other": "string",
"callID": "string",
"callStatus": 0,
"callStartTs": 0,
"intents": [
{
"intentID": "string",
"intentTag": "string",
"intentName": "string",
"intentLevel": 0
}
]
}
]
}
返回结果
状态码 | 状态码含义 | 说明 |
---|---|---|
200 | OK | 成功 |
响应的header
名称 | 类型 | 必选 | 说明 |
---|---|---|---|
requestID | string | 是 | 与请求头一致 |
uuid | string | 是 | 与请求头一致 |
createTs | string | 是 | 响应时的秒级时间戳 |
sign | string | 是 | 生成方法与请求头sign生成算法一样,如果响应体是被压缩的,要解压后再验证签名。 |
algorithm | string | 否 | 与请求头一致,签名的算法:MD5或者SHA256,不填默认用MD5。 |
返回数据结构
状态码 200
名称 | 类型 | 必选 | 约束 | 说明 |
---|---|---|---|---|
» retCode | integer | true | none | 响应码 |
» retMsg | string | true | none | 响应消息 |
» responseID | string | true | none | 响应id |
» totalCount | integer | true | none | 订单总数 |
» batchID | string | true | none | 批次ID |
» callList | [object] | true | none | 返回通话列表 |
»» orderID | string | false | none | 订单id |
»» userPhone | string | false | none | 手机号 |
»» other | string | false | none | 透传字段 |
»» callID | string | false | none | 通话ID |
»» callStatus | integer | false | none | 通话状态 |
»» callStartTs | integer | false | none | 通话拨打时间戳 |
»» intents | [object] | false | none | 意向 |
»»» intentID | string | false | none | 意向标签id |
»»» intentTag | string | false | none | 意向标签tag |
»»» intentName | string | false | none | 意向标签名 |
»»» intentLevel | integer | true | none | 意向优先级 |