DID号码短信记录查询

DID号码短信记录查询,只支持查询最近31天的短信记录，请及时查询。如需要全量短信记录维护，也可以使用回执回调功能，自动接收数据并保存。

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

鉴权机制

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

请求参数

header参数：

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

body参数：

参数名	类型	必选	示例值	说明
startDate	String	是	2022-10-01 00:00:00	日期(yyyy-MM-dd HH:mm:ss) 开始时间与结束时间范围不能超过5天
endDate	String	是	2022-10-02 00:00:00	日期(yyyy-MM-dd HH:mm:ss) 开始时间与结束时间范围不能超过5天
pageSize	Integer	是	10	每页数量(小于1000条)
page	Integer	是	1	起始页
didNumber	String	否	123456789	DID号码, 为空时将不限制DID号码
type	Integer	否	0	短信类型：0上行，1下行

请求示例

{
    "type": 0,
    "startDate": "2022-08-23 00:00:00 ",
    "endDate": "2022-08-23 23:59:59",
    "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参数：

参数名	类型	说明
countryName	string	国家方向
didNumber	string	DID号码
phone	string	对方号码
type	int	短信类型：0上行，1下行
content	string	内容
customerMessageId	string	客户messageid
status	int	状态：0提交失败，1提交成功，2DELIVRD，3UNDELIVR
size	int	计费条数
totalPrice	bigDecimal	总价
sendTime	int	发送时间

响应示例

成功示例

{
    "code": 0,
    "data": {
        "totalRow": 1,
        "pageNumber": 1,
        "totalPage": 1,
        "pageSize": 10,
        "list": [
            {
                "countryName": "美国",
                "didNumber": "+18506008399",
                "phone": "+15304412724",
                "type": 0,
                "content": "test",
                "customerMessageId": "0c2f0f8aa90b48f3ad82d6a8dea6725b",
                "status": 2,
                "size": 1,
                "totalPrice": 0.1000,
                "sendTime": "2022-05-31 15:28:07"
            }
        ]
    },
    "message": "Success"
}

失败示例

{
    "code": 9000,
    "message": "startDate cannot be empty"
}

响应码说明

code	message	解决办法
0	Success
-1	Failure	请联系技术人员排除问题
1000~100X	鉴权问题	详情查看API鉴权部分
1100	Customer does not exist / Status is unavailable	检查客户信息是否有效
9000	Request parameter error	根据返回内容检查请求的参数限制
12009	Type not in (0, 1)	检查请求的Type类型