接口文档

API上行回复获取接口

1.1 调用地址

地址：http://address:port/sms/api/getUpstream

请求方法：POST

1.2 请求包头定义

Accept: application/json

Content-Type: application/json;charset=utf-8

1.3 请求参数

此接口每次请求间隔时间不得小于30秒，如果获取条数为2000条表示还有上行未获取，可立即再次请求获取上行数据。

参数名	类型	必填	说明
userName	String	是	帐号用户名
timestamp	Long	是	当前时间戳，精确到毫秒。例如2020年8月1日12:00:00 时间戳为：1596254400000
sign	String	是	由以下参数值组合成字符串并计算MD5值，参考详细规则计算：MD5(userName + timestamp + MD5(password))

1.4 响应结果

响应数据为JSON形式，每次获取不大于2000条，已获取的数据不会被再次获取到。

参数名	类型	说明
code	Integer	处理结果，0为成功，其他失败，详细参考响应状态码
message	String	处理结果描述
data	[Array]	获取的上行列表。JSON数组形式，具体字段如下

data包含推送字段如下（与5.4推送参数一致）

参数名	类型	必填	说明
content	String	是	上行回复内容
phone	String	是	手机号码
receiveTime	String	是	回执时间，格式：yyyy-MM-dd HH:mm:ss
destId	String	否	通道端口号
msgId	Long	否	短信发送提交时响应的消息id
callData	String	否	用户回传数据，如果提交时有传递此参数将原样推送带回

1.5 请求示例

状态获取请求：

POST http://address:port/sms/api/getUpstream

Accept: application/json

Content-Type: application/json;charset=utf-8

{

"userName": "test",

"timestamp": 1596254400000,

"sign": "e315cf297826abdeb2092cc57f29f0bf"

}

响应结果：

{

"code": 0,

"message": "处理成功",

"data": [

{

"content": "好的, 已收到",

"destId": "106203069598",

"phone": "13500000001",

"receiveTime": "2020-06-09 11:10:32"

},

{

"content": "OK",

"phone": "13500000002",

"receiveTime": "2020-06-09 11:10:32"

}

]

}