NXCC API cdrQuery - nxtele/http-api-document GitHub Wiki

  • URL：https://api2.nxcloud.com/saas/cc/openapi/cdr/page
  • Method：POST
  • Content-Type：application/json
  • 需要鉴权：是

鉴权机制

鉴权规则请参考地址：API 接口调用约定

请求参数

header 参数：

参数名 类型 必选 示例值 说明
accessKey String 是 fme2na3kdi3ki 用户身份标识
ts String 是 1655710885431 当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为 60 秒
bizType String 是 6 业务类型，取固定值“8”
action String 是 cc 业务操作，取固定值“cc”
sign String 是 6e9506557d1f289501d333ee2c365826 API 入参参数签名，签名算法

body 参数：

参数名 类型 必选 示例值 说明
answered Integer 否 0 是否接听：0所有 1未接听 2接听
direction Integer 否 0 呼叫方向：0所有 1呼入 2呼出 3AICC
startTime Long 是 1678894227239 开始时间（时间戳 秒）
endTime Long 是 1678894227239 结束时间（时间戳 秒）
name String 否 "NX0001" 员工账号 / 坐席账号
caller String 否 "4444" 主叫号码
callee String 否 "4444" 被叫号码
callId String 否 "032f4f81cc7a4e5a902e41f511fbf0e9" callId
orderId String fou "033f4f81cc7a4e5a902e41f511fbf010" orderId
size Integer 是 100 每页大小（最大 100）
page Integer 是 1 页数（从 1 开始）

请求示例

body（application/json） 参数：

{
  "startTime": 1688140800,
  "endTime": 1690819200,
  "answered": true,
  "direction": 1,
  "name": "NX0001",
  "caller": "4444",
  "callee": "4444",
  "orderId": "1222222",
  "size": 100,
  "page": 1
}

响应参数

参数名 类型 说明
code Integer 结果编码
data Object 请求结果
msg String 请求结果说明

请求成功

  • data 参数：
参数名 类型 说明
agentName String 客服账号，可能为空
agentNickName String 客服昵称，可能为空
answered Boolean 是否接听
answerTime Long 呼叫接通时间（时间戳 毫秒）
callDuration Integer 通话时长
callee String 被叫号码
caller String 主叫号码
callId String 通话 id
orderId String orderid
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": "请求成功",
    "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": "呼入未接",
            "hangupReason": "用户排队放弃",
            "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": "示例坐席",
            "answered": true,
            "answerTime": 1690423244000,
            "callDuration": 5,
            "callee": "85235757568",
            "caller": "85238531117",
            "callId": "6605fcd9563616c6c009c6240",
            "direction": 0,
            "dtmfKeys": null,
            "endTime": 1690423248124,
            "hangupBy": 1,
            "hangupCode": 1001,
            "callStatus": "正常结束",
            "hangupReason": "坐席挂断",
            "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 解决办法
0 请求成功
88 请求失败 请联系技术人员排除问题
99 系统错误 请联系技术人员排除问题
1000~100X 鉴权问题 详情查看 API 鉴权部分

hangupCode含义

挂断码 类型 说明
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 转人工失败-用户取消