-
Notifications
You must be signed in to change notification settings - Fork 6
Callbot API callList
Jcateye edited this page Dec 16, 2024
·
4 revisions
v1.0.0
Base URLs:
鉴权请查看文档https://github.com/nxtele/http-api-document/wiki/Callbot-API-authorization
POST /callcentre/api/v3/listCall
列出通话列表
返回响应码 | 错误原因 |
---|---|
0 | 成功 |
1 | 通用错误 |
2 | 参数丢失 |
3 | 参数格式错误 |
4 | 参数值错误 |
4001 | 参数内容容量错误(数组元素过多) |
5 | 服务器维护 |
5001 | 服务器内部错误 |
6 | 签名不正确 |
6001 | 签名错误丢失 |
6001 | 签名错误丢失 |
6002 | 账号不存在 |
6003 | 用户没有权限 |
7 | 系统正忙 |
Body 请求参数
{
"productID": "callbot",
"userTaskID": "string",
"options": {
"callID": [
"string"
],
"intentID": [
"string"
],
"intentName": [
"string"
],
"intentTag": [
"string"
],
"intentLevel": [
0
],
"turnTime": {
"gt": 0,
"lt": 0,
"enable": true
},
"callDuration": {
"gt": 0,
"lt": 0,
"enable": true
},
"callStatus": [
1
],
"startTs": 0,
"endTs": 0
},
"page": 1,
"size": 100
}
名称 | 位置 | 类型 | 必选 | 说明 |
---|---|---|---|---|
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 | 否 | |
» productID | body | string | 是 | 产品id,定值"callbot" |
» userTaskID | body | string | 是 | 任务id,请求方的任务id(调用方生成并且保证唯一),建议使用uuid |
» options | body | object | 是 | 查询条件 |
»» callID | body | [string]¦null | 否 | 通话id |
»»» callingNumber | string | true | none | 主叫号码 |
»»» lineAddress | string | true | none | 线路IP |
»» intentID | body | [string]¦null | 否 | 意向标签id,后台意向标签id,可通过查询该任务所属话术模板的意向标签设置获取 |
»» intentName | body | [string]¦null | 否 | 意向标签名,后台意向标签名,可通过查询该任务所属话术模板的意向标签设置获取 |
»» intentTag | body | [string]¦null | 否 | 意向标签tag,用户自定义的意向标签tag |
»» intentLevel | body | [integer] | 是 | 意向优先级,后台意向优先级 |
»» turnTime | body | object¦null | 否 | 对话轮次 |
»»» gt | body | integer | 否 | 大于 |
»»» lt | body | integer | 否 | 小于 |
»»» enable | body | boolean | 是 | 使用对话轮次条件 |
»» callDuration | body | object¦null | 否 | 通话时长 |
»»» gt | body | integer | 否 | 大于 |
»»» lt | body | integer | 否 | 小于 |
»»» enable | body | boolean | 是 | 条件是否使用 |
»» callStatus | body | [integer]¦null | 否 | 通话状态,通话订单所属的通话的状态。枚举值请参考《通话状态枚举值文档》 |
»» startTs | body | integer | 是 | 通话拨打时间筛选开始时间,秒级时间戳,大于等于 |
»» endTs | body | integer | 是 | 通话拨打时间筛选结束时间,秒级时间戳,小于 |
» page | body | integer | 是 | 页码 |
» size | body | integer | 是 | 页面大小 |
属性 | 值 | |
---|---|---|
»» callStatus | 1 | 准备通话 |
»» callStatus | 2 | 调度中 |
»» callStatus | 3 | 拨打中 |
»» callStatus | 4 | 响铃中 |
»» callStatus | 5 | 正在通话 |
»» callStatus | 6 | 通话结束-完成通话 |
»» callStatus | 8 | 通话结束-不合法号码 |
»» callStatus | 9 | 通话结束-暂时无法接通 |
»» callStatus | 10 | 通话结束-用户占线 |
»» callStatus | 11 | 通话结束-用户忙线并拒接 |
»» callStatus | 12 | 通话结束-用户拒接 |
»» callStatus | 13 | 通话结束-用户拒接 |
»» callStatus | 15 | 通话结束-tts合成失败 |
»» callStatus | 16 | 通话结束-未知原因 |
»» callStatus | 17 | 通话结束-黑名单号码 |
»» callStatus | 18 | 通话结束-用户叫停 |
»» callStatus | 21 | 通话结束-无效号码(号码检测非法,不满足当地号段) |
»» callStatus | 22 | 通话结束-响铃不接 |
»» callStatus | 23 | 通话结束-拨打没响应 |
»» callStatus | 24 | 通话结束-早媒体-语音信箱 |
»» callStatus | 25 | 通话结束-响铃过长 |
返回示例
200 Response
{
"retCode": 0,
"retMsg": "string",
"responseID": "string",
"totalCount": 0,
"callList": [
{
"orderID": "string",
"userPhone": "string",
"userName": "string",
"sceneID": "string",
"userTaskID": "string",
"taskID": "string",
"other": "string",
"callInfoDetail": {
"callID": "string",
"callStatus": 1,
"callStartTs": 0,
"callAnswerTs": 0,
"callEndTs": 0,
"callDuration": 0,
"callAudioUrl": "string",
"hangupCause": "string",
"termSipCode": "string",
"intents": [
{
"intentID": null,
"intentTag": null,
"intentName": null,
"intentLevel": null
}
],
"sms": [
{
"smsSendTs": null,
"sysMessageID": null,
"smsContent": null
}
],
"agent": {
"agentName": "string",
"agentGroup": "string",
"agentCallStatus": "[",
"agentCallElapsed": 0,
"agentLabel": "string",
"manualCallStart": 0,
"manualCallAnswer": 0,
"manualCallEnd": 0,
"manualHangupBy": 0
},
"params": [
{
"name": null,
"value": null
}
]
}
}
]
}
状态码 | 状态码含义 | 说明 | 数据模型 |
---|---|---|---|
200 | OK | 成功 | Inline |
名称 | 类型 | 必选 | 说明 |
---|---|---|---|
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 | 通话总数 |
» callList | [object] | true | none | 返回订单列表 |
»» orderID | string | true | none | 订单id |
»» userPhone | string | true | none | 手机号 |
»» userName | string | true | none | 用户名 |
»» sceneID | string | true | none | 话术模板id |
»» userTaskID | string | true | none | 用户任务id |
»» taskID | string | true | none | 任务id |
»» other | string | true | none | 透传字段 |
»» callInfoDetail | object | true | none | 通话详细信息 |
»»» callID | string | true | none | 通话id |
»»» callStatus | integer | true | none | 通话状态 |
»»» callStartTs | integer | true | none | 通话拨打时间戳 |
»»» callAnswerTs | integer | true | none | 通话接听时间戳,接听时间戳有值不代表通话被接听,请参照callStatus判断通话状态 |
»»» callEndTs | integer | true | none | 通话挂断时间戳 |
»»» callDuration | integer | true | none | 通话接听秒数 |
»»» callAudioUrl | string | true | none | 通话录音Url,通话录音url(有效期3个月),格式为wav,形如https://xxxx.wav |
»»» hangupCause | string | true | none | 挂断原因 |
»»» termSipCode | string | true | none | sipCode |
»»» intents | [object] | true | none | 意向,可通过查询该任务所属话术模板的意向标签设置获取 |
»»»» intentID | string | true | none | 意向标签id |
»»»» intentTag | string | true | none | 意向标签tag,可通过查询该任务所属话术模板的意向标签设置获取 |
»»»» intentName | string | true | none | 意向标签名 |
»»»» intentLevel | integer | true | none | 意向优先级 |
»»» sms | [object] | false | none | 短信 |
»»»» smsSendTs | integer | true | none | 短信发送时间 |
»»»» sysMessageID | string | true | none | 短信发送id |
»»»» smsContent | string | true | none | 短信发送内容 |
»»» agent | object | false | none | 坐席相关信息 |
»»»» agentName | string | true | none | 接听坐席名 |
»»»» agentGroup | string | true | none | 接听坐席组 |
»»»» agentCallStatus | integer | true | none | 坐席接听状态 |
»»»» agentCallElapsed | integer | true | none | 坐席接听时长 |
»»»» agentLabel | string | true | none | 坐席标签 |
»»»» manualCallStart | integer | true | none | 转人工开始时间戳 |
»»»» manualCallAnswer | integer | true | none | 转人工应答时间戳 |
»»»» manualCallEnd | integer | true | none | 转人工结束时间戳 |
»»»» manualHangupBy | integer | true | none | 被谁挂断了0:none,1:坐席挂断,2:用户挂断 |
»»» params | [object] | false | none | 变量 |
»»»» name | string | true | none | 变量名 |
»»»» value | string | true | none | 变量值 |
属性 | 值 | |
---|---|---|
»» callStatus | 1 | 准备通话 |
»» callStatus | 2 | 调度中 |
»» callStatus | 3 | 拨打中 |
»» callStatus | 4 | 响铃中 |
»» callStatus | 5 | 正在通话 |
»» callStatus | 6 | 通话结束-完成通话 |
»» callStatus | 8 | 通话结束-不合法号码 |
»» callStatus | 9 | 通话结束-暂时无法接通 |
»» callStatus | 10 | 通话结束-用户占线 |
»» callStatus | 11 | 通话结束-用户忙线并拒接 |
»» callStatus | 12 | 通话结束-用户拒接 |
»» callStatus | 13 | 通话结束-用户拒接 |
»» callStatus | 15 | 通话结束-tts合成失败 |
»» callStatus | 16 | 通话结束-未知原因 |
»» callStatus | 17 | 通话结束-黑名单号码 |
»» callStatus | 18 | 通话结束-用户叫停 |
»» callStatus | 21 | 通话结束-无效号码(号码检测非法,不满足当地号段) |
»» callStatus | 22 | 通话结束-响铃不接 |
»» callStatus | 23 | 通话结束-拨打没响应 |
»» callStatus | 24 | 通话结束-早媒体-语音信箱 |
»» callStatus | 25 | 通话结束-响铃过长 |
»»» smsSendTs | 0 | 未发送 |
»»» smsSendTs | 1 | 已发送 |
»»» smsSendTs | 2 | 发送成功 |
»»» smsSendTs | 3 | 发送失败 |
»»» smsSendTs | 4 | 点击成功 |
»»» agentCallStatus | 1 | 拨打中 |
»»» agentCallStatus | 2 | 响铃中 |
»»» agentCallStatus | 3 | 接通 |
»»» agentCallStatus | 4 | 完成通话 |
»»» agentCallStatus | 10 | 通话完成-坐席繁忙 |
»»» agentCallStatus | 12 | 通话完成-用户拒接 |
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_v1
- 已上传录音文件查询
- 发送语音群呼
- 发送语音通知
- 发送语音验证码
- 语音验证码回填上报
- 语音回执回调
- 语音记录查询
- 上传语音录音文件-旧版本已废弃
- 发送语音群呼‐旧版已废弃
- 发送语音通知‐旧版已废弃
- 发送语音验证码‐旧版已废弃
- 语音回执回调‐旧版已废弃
云呼叫中心(NXLink)
- Web SDK
- Iframe集成
- 手动拨号通话记录查询
- 通过orderId查询
- 手动拨号记录回调
- 坐席信息查询
- 坐席状态查询
- 坐席组查询
- 坐席可用主叫查询
- 坐席组成员查询
- 坐席组更新成员
- 坐席效率统计
- 创建AICC外呼任务
- Webhook-手动外呼
云呼叫中心(AI自动外呼)
- Callbot API概述
- Callbot API鉴权
- Callbot 接口探活
- 创建自动拨号任务
- 批量添加拨打名单
- 创建自动拨号任务并添加拨打名单
- 任务控制(启动/暂停)
- 更新任务
- 获取通话列表
- 获取任务列表
- 获取拨打订单列表
- 停止订单拨打
- 查询订单维度拨打详情
- 通话维度回调
- 订单维度拨打回调
- 任务状态回调
- 批次-导出最新批次数据
- 批次-导入最新批次数据
Flash Call
短链
邮件验证码
DID号码
- DID号码进行短信下行V2
- DID短信结果回调(加签)
- DID短信结果回调(无加签)
- DID号码短信记录查询(新接口,未启用)
- DID号码通话记录查询
- DID呼出并转接到Amazon坐席
- DID呼出前与Connect号码绑定
通用
号码检测
- 发送消息
- webhook
- 标记入站消息已读
- 上传媒体文件
- 获取媒体文件
- 删除媒体文件
- 查询号码信息
- 查询消息模板
- 创建消息模板
- 编辑消息模板
- 删除消息模板
- 上传模板示例文件
- 嵌入式页面登录
- 创建客户应用
- 客户应用的号码列表
- 获取验证码
- 核验验证码
- flows-创建流
- flows-更新流
- flows-根据流ID查询流信息
- flows-根据whatsapp号码查询流列表
- flows-根据流ID查询流预览地址
- flows-查询流JSON
- flows-发布流
- flows-删除流草稿
- flows-废弃已发布的流
- flows-更新流JSON
- flows-上传业务公钥
- ads-根据公共主页ID查询绑定的数据集列表
- ads-根据数据集ID上报CAPI广告数据
Viber
Zalo ZNS
Super Message API
隐私号(旧)
PNS
坐席(旧版)
- NXphone PC 使用说明
- NXphone Android 使用说明
- NXphone Android SDK 接入文档
- 呼叫挂断原因解释
- 话单CDR查询接口
- 话单CDR回调接口说明(V1.0)
- 坐席API调用接口说明(V1.0)
- 根据orderid查询话单CDR接口
- 坐席系统sip链接调用方式(推荐)
- 号码脱敏处理
- 修改话机密码接口
- 查询审批单
- 查询话机
- WebRTC SDK使用说明
AI Agent(对外api)