地址:http://address:port/sms/api/getReport
请求方法:POST
Accept: application/json
Content-Type: application/json;charset=utf-8
此接口每次请求间隔时间不得小于30秒,如果获取条数为2000条表示还有回执未获取,可立即再次请求获取回执。
参数名 | 类型 | 必填 | 说明 |
userName | String | 是 | 帐号用户名 |
timestamp | Long | 是 | 当前时间戳,精确到毫秒。 例如2020年8月1日12:00:00 时间戳为:1596254400000 |
sign | String | 是 | 由以下参数值组合成字符串并计算MD5值,参考详细规则 计算:MD5(userName + timestamp + MD5(password)) |
响应数据为JSON形式,每次获取不大于2000条,已获取的数据不会被再次获取到。
参数名 | 类型 | 说明 |
code | Integer | 处理结果,0为成功,其他失败,详细参考响应状态码 |
message | String | 处理结果描述 |
data | [Array] | 获取的回执列表。JSON数组形式,具体字段如下 |
data包含推送字段如下(与4.4推送参数一致)
参数名 | 类型 | 必填 | 说明 |
msgId | Long | 是 | 消息id,对应发送成功时系统响应的msgId |
phone | String | 是 | 手机号码 |
status | String | 是 | 回执状态,DELIVRD成功,其他失败 |
receiveTime | String | 是 | 回执时间,格式:yyyy-MM-dd HH:mm:ss |
callData | String | 否 | 用户回传数据,如果提交时有传递此参数将原样推送带回 |
1.1 请求示例
状态获取请求:
POST http://address:port/sms/api/getReport
Accept: application/json
Content-Type: application/json;charset=utf-8
{
"userName": "test",
"timestamp": 1596254400000,
"sign": "e315cf297826abdeb2092cc57f29f0bf"
}
响应结果:
{
"code": 0,
"message": "处理成功",
"data": [
{
"msgId": 11600001,
"phone": "13500000001",
"receiveTime": "2020-06-09 11:10:32",
"status": "DELIVRD"
},
{
"msgId": 11600002,
"phone": "13500000002",
"receiveTime": "2020-06-09 11:10:32",
"status": "FAILURE"
}
]
}