-
Couldn't load subscription status.
- Fork 6
NXCC API cdrQueryByOrder
aofei edited this page Feb 20, 2025
·
3 revisions
通过orderid查询cdr记录
- URL:
https://api2.nxcloud.com/saas/cc/openapi/cdr/queryByOrderId - Method:
POST - Content-Type:
application/json - Required:
yes
鉴权规则请参考地址:API 接口调用约定
| 参数名 | 类型 | 必选 | 示例值 | 说明 |
|---|---|---|---|---|
| accessKey | String | Y | fme2na3kdi3ki | 用户身份标识 |
| ts | String | Y | 1655710885431 | 当前请求的时间戳(单位是毫秒),牛信服务端允许用户端请求最大时间误差为 60 秒 |
| bizType | String | Y | 8 | 业务类型,取固定值“8” |
| action | String | Y | cc | 业务操作,取固定值“cc” |
| sign | String | Y | 6e9506557d1f289501d333ee2c365826 | API 入参参数签名,签名算法 |
| 参数名 | 类型 | 必选 | 示例值 | 说明 |
|---|---|---|---|---|
| tenantId | Integer | Y | 144 | 团队ID, 从牛信页面查询到并配置 |
| orderId | string | N | 业务id,客户侧发起呼叫的业务id |
body(application/json):
{
"tenantId": 144,
"orderId": "12333333XXX"
}| name | type | Description |
|---|---|---|
| code | Integer | code |
| data | Object | reponse data |
| msg | String | message |
- data :
| 参数名 | 类型 | 说明 |
|---|---|---|
| agentName | String | 客服账号,可能为空 |
| agentNickName | String | 客服昵称,可能为空 |
| answered | Boolean | 是否接听 |
| answerTime | Long | 呼叫接通时间(时间戳 毫秒) |
| callDuration | Integer | 通话时长 |
| callee | String | 被叫号码 |
| caller | String | 主叫号码 |
| callId | String | 通话 id |
| direction | Integer | 呼叫方向,0:呼入,1:呼出,2:AICC |
| dtmfKeys | String | dtmf 按键,多个时候使用英文逗号分割 |
| endTime | Long | 呼叫结束时间(时间戳 毫秒) |
| hangupBy | Integer | 挂断方,挂断方,0:客服挂断,1:用户挂断,2:未知 |
| hangupCode | Integer | 挂断原因码 |
| callStatus | String | 通话状态 |
| hangupReason | String | 挂断原因说明 |
| inQueueTime | Long | 入队时间戳(时间戳 毫秒) |
| leaveMsgUrl | String | 留言 url |
| orderId | String | 订单 id |
| other | String | 透传信息 |
| intent | String | 意图名称 |
| outQueueTime | Long | 出队时间戳(时间戳 毫秒) |
| queueDuration | Integer | 排队时长(单位 秒) |
| recordUrl | String | 录音 url |
| ringDuration | Integer | 响铃时长(单位 秒) |
| ringTime | Long | 呼叫响铃时间(时间戳 毫秒) |
| startTime | Long | 呼叫开始时间(时间戳 毫秒) |
| taskId | String | 任务 ID,direction=2时展示的AICC任务信息 |
| totalCustomerPrice | BigDecimal | 费用 |
| lineIp | String | 线路IP |
| mediaIp | String | 预留,目前为空值 |
| termSipCode | Integer | 线路返回的sipcode |
| hangupCause | String | 线路返回的hangupCause |
| mos | BigDecimal | 语言质量mos值,值越大语言质量越好 |
{
"reqId": "a23738fb613d889026fa2c8f4e4378f1",
"code": 0,
"msg": "Success",
"data": [
{
"agentName": null,
"agentNickName": null,
"answered": false,
"answerTime": 0,
"callDuration": 0,
"callee": "85235757580",
"caller": "85215236100",
"callId": "63b09b9a163616c6c009cb326",
"direction": 0,
"dtmfKeys": null,
"endTime": 1690442498901,
"hangupBy": 0,
"hangupCode": 1103,
"callStatus": "Missed Call",
"hangupReason": "User abandoned while in queue",
"inQueueTime": 1690442492861,
"leaveMsgUrl": null,
"orderId": "",
"other": null,
"intent": null,
"outQueueTime": 1690442498000,
"queueDuration": 5139,
"recordUrl": null,
"ringDuration": 6,
"ringTime": 1690442492000,
"startTime": 1690442492841,
"taskId": "",
"totalCustomerPrice": 0.035,
"lineIp": "127.0.0.1",
"mediaIp": "",
"termSipCode": 487,
"hangupCause": "ORIGINATOR_CANCEL",
"mos": 4.4200
},
{
"agentName": "NX094450006938",
"agentNickName": "Example Agent",
"answered": true,
"answerTime": 1690423244000,
"callDuration": 5,
"callee": "85235757568",
"caller": "85238531117",
"callId": "6605fcd9563616c6c009c6240",
"direction": 0,
"dtmfKeys": null,
"endTime": 1690423248124,
"hangupBy": 1,
"hangupCode": 1001,
"callStatus": "Normal",
"hangupReason": "Agent hang-up",
"inQueueTime": 1690423237744,
"leaveMsgUrl": null,
"orderId": "",
"other": null,
"intent": null,
"outQueueTime": 1690423244000,
"queueDuration": 6,
"recordUrl": "https://*********.mp3",
"ringDuration": 7,
"ringTime": 1690423237000,
"startTime": 1690423237704,
"taskId": "",
"totalCustomerPrice": 0.035,
"lineIp": "127.0.0.1",
"mediaIp": "",
"termSipCode": 487,
"hangupCause": "ORIGINATOR_CANCEL",
"mos": 4.4200
}
]
}{
"reqId": "FFDD1791E22F4D9DBA967C245C58E544",
"code": 41000,
"msg": "结束日期不能为空",
"data": {}
}| code | message | Resolution |
|---|---|---|
| 0 | Success | |
| 88 | Failure | 请联系技术人员排除问题 |
| 99 | System Error | 请联系技术人员排除问题 |
| 1000~100X | Authorization Failed | 详情查看 API 鉴权部分 |
| 挂断码 | 类型 | 说明 |
|---|---|---|
| 1000 | 呼入 | 正常结束 |
| 1001 | 呼入 | 正常结束-坐席挂断 |
| 1002 | 呼入 | 正常结束-用户挂断 |
| 1003 | 呼入 | 正常结束-留言信箱 |
| 1004 | 呼入 | 正常结束-网络中断 |
| 10031 | 呼入 | 正常结束-留言信箱-坐席全忙 |
| 10032 | 呼入 | 正常结束-留言信箱-无坐席在线 |
| 1101 | 呼入 | 呼入未接-坐席速挂 |
| 1102 | 呼入 | 呼入未接-用户速挂 |
| 1103 | 呼入 | 呼入未接-用户排队放弃 |
| 11031 | 呼入 | 呼入未接-用户排队放弃-坐席全忙 |
| 11032 | 呼入 | 呼入未接-用户排队放弃-无坐席在线 |
| 1104 | 呼入 | 呼入未接-用户排队超时 |
| 11041 | 呼入 | 呼入未接-用户排队超时-坐席全忙 |
| 11042 | 呼入 | 呼入未接-用户排队超时-无坐席在线 |
| 1105 | 呼入 | 呼入未接-无坐席在线 |
| 1106 | 呼入 | 呼入未接-坐席全忙 |
| 1107 | 呼入 | 呼入未接-黑名单号码 |
| 1108 | 呼入 | 呼入未接-用户取消 |
| 1109 | 呼入 | 呼入转外部号码-外线挂断 |
| 1110 | 呼入 | 呼入转外部号码-无法接通 |
| 1111 | 呼入 | 呼入转外部号码-用户挂断 |
| 2000 | 呼出 | 正常结束 |
| 2001 | 呼出 | 正常结束-坐席挂断 |
| 2002 | 呼出 | 正常结束-用户挂断 |
| 2003 | 呼出 | 正常结束-坐席取消 |
| 2004 | 呼出 | 正常结束-网络中断 |
| 2101 | 呼出 | 呼出未接-坐席速挂 |
| 2102 | 呼出 | 呼出未接-用户速挂 |
| 2103 | 呼出 | 呼出未接-用户响铃拒接 |
| 2104 | 呼出 | 呼出未接-超时未接 |
| 2105 | 呼出 | 呼出未接-黑名单号码 |
| 2106 | 呼出 | 呼出未接-呼叫限制号码 |
| 2107 | 呼出 | 呼出未接-呼叫限制(体验次数) |
| 2201 | 呼出 | 无法接通-呼叫拒绝 |
| 2202 | 呼出 | 无法接通-暂时无法接通 |
| 2203 | 呼出 | 无法接通-线路繁忙 |
| 2204 | 呼出 | 无法接通-呼叫异常 |
| 2205 | 呼出 | 无法接通-无法接通 |
| 2206 | 呼出 | 无法接通-坐席取消 |
| 3000 | AICC | 正常结束 |
| 3001 | AICC | 转人工成功-坐席挂断 |
| 3002 | AICC | 转人工成功-用户挂断 |
| 3003 | AICC | 转人工成功-网络中断 |
| 3101 | AICC | 转人工失败-坐席速挂 |
| 3102 | AICC | 转人工失败-用户速挂 |
| 3103 | AICC | 转人工失败-用户排队放弃 |
| 3104 | AICC | 转人工失败-用户排队超时 |
| 31041 | AICC | 转人工失败-用户排队超时-坐席全忙 |
| 31042 | AICC | 转人工失败-用户排队超时-无坐席在线 |
| 3105 | AICC | 转人工失败-无坐席在线 |
| 3106 | AICC | 转人工失败-坐席全忙 |
| 3107 | AICC | 转人工失败-用户取消 |
简介
短信
语音
- 上传语音录音文件
- 上传语音录音文件_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号码绑定
通用
号码检测
- 发送消息
- 发送otp消息
- webhook
- 标记入站消息已读
- 上传媒体文件
- 获取媒体文件
- 删除媒体文件
- 查询号码信息
- 查询消息模板
- 创建消息模板
- 异步创建消息模板
- 编辑消息模板
- 删除消息模板
- 上传模板示例文件
- 嵌入式页面登录
- 创建客户应用
- 客户应用的号码列表
- 获取验证码
- 核验验证码
- flows-创建流
- flows-更新流
- flows-根据流ID查询流信息
- flows-根据whatsapp号码查询流列表
- flows-根据流ID查询流预览地址
- flows-查询流JSON
- flows-发布流
- flows-删除流草稿
- flows-废弃已发布的流
- flows-更新流JSON
- flows-上传业务公钥
- ads-根据公共主页ID查询绑定的数据集列表
- ads-根据数据集ID上报CAPI广告数据
- 封锁用户
- 业务主页
- 查询消息记录
- 查询calling配置
- 查询calling通话记录
- 禁用calling配置
- 启用calling配置
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