DID号码通话记录查询 - nxtele/http-api-document GitHub Wiki

DID号码通话记录查询

URL：https://api2.nxcloud.com/api/did/cdr
Method：POST
Content-Type：application/json
需要鉴权：是

鉴权机制

请求参数

header参数：

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

body参数：

参数名	类型	必选	示例值	说明
date	string	是	2022-10-01	日期(yyyy-MM-dd)
pageSize	integer	是	10	每页数量(小于1000条)
page	integer	是	1	起始页
didNumber	string	否	123456789	DID号码, 为空时将不限制DID号码
callNumber	string	否	123456789	对方号码，为空时将不限制对方号码
type	integer	否	0	通话类型：0呼入，1呼出。为空时将不限制通话类型

请求示例

{
    "type": 0,
    "date": "2022-08-23",
    "pageSize": 10,
    "page": 1
}

响应参数

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

data Object参数：

参数名	类型	说明
totalRow	Integer	数据总条数
pageNumber	Integer	当前页数
totalPage	Integer	数据总页数
pageSize	Integer	每页数量
list	array of items	当前分页结果列表

list item参数：

参数名	类型	说明
number	string	DID号码
callNumber	string	对方号码
callType	int	通话类型：0呼入，1呼出
countryName	string	国家方向
callDuration	long	通话时长（秒）
feeType	int	计费方式：0:60+60 1:1+1
feeDurationMinute	bigDecimal	计费时长（分）
callPriceUnit	bigDecimal	通话单价(元)
callPrice	bigDecimal	通话费（元）
endDirection	int	挂断方：0主叫， 1被叫, other：其他
endReason	string	终止原因编码
endReasonName	string	终止原因
callerIp	string	主叫IP
calleeIp	string	被叫IP
startTime	string	通话接通时间
endTime	string	通话挂断时间

响应示例

成功示例

{
    "code": 0,
    "data": {
        "totalRow": 1,
        "pageNumber": 1,
        "totalPage": 1,
        "pageSize": 10,
        "list": [
            {
                "callDuration": 64,
                "endReason": "-7",
                "feeDurationMinute": 2,
                "feeType": 0,
                "callType": 0,
                "callerIp": "127.0.0.1",
                "endReasonName": "主叫挂断",
                "callNumber": "123456789",
                "calleeIp": "127.0.0.1",
                "callPrice": 0.11,
                "endDirection": 0,
                "startTime": "2022-10-01 11:04:57",
                "id": 1,
                "countryName": "泰国",
                "endTime": "2022-10-01 11:06:01",
                "callPriceUnit": 0.055
            }
        ]
    },
    "message": "请求成功"
}

失败示例

{
    "code": 1002,
    "data": null,
    "message": "参数错误"
}

响应码说明

code	message	解决办法
0	请求成功
-1	请求失败	请联系技术人员排除问题
1002	参数错误	参数异常，请检查必须的参数
1000~100X	鉴权问题	详情查看API鉴权部分