推送状态报告
功能说明:开通此接口后,我们将为您实时推送最新的状态报告。您需要提供一个callback url地址,接受http post请求。 该接口一次最多推送100个状态报告,为不影响推送速度,建议先接受数据后再做异步处理。
备注:#
- 本功能默认不开启,如需开启请前往“系统设置-短信状态报告异步通知”页设置。您可以设置固定的callback url 地址,也可以在每次发送请求中携带callback url 地址。我们会优先向发送请求中携带的callback url 地址推送。
- 接收到数据后,数据处理成功请返回字符串"SUCCESS",其他返回值将被认为是失败。该接口失败重试次数为3次,每次间隔5分钟。
- 获取数据后,建议根据sid做去重。
- 一条短信报告运营商可能会有多次结果状态返回,已最后一次为准
HTTP头信息:#
Content-Type:application/json;charset=utf-8;请求#
URL:http://your_receive_url_address 访问方式:POST 访问参数: 已JSON 格式推送请求参数#
| 参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
| mobile | string | 是 | 接收手机号 |
| sid | long(64 位) | 是 | sid 发送接口返回的参数 |
| busId | string | 否 | 您上送的业务系统内的 ID |
| reportState | string | 是 | 接收状态有: "SUCCESS"/ "FAIL" |
| errorState | string | 是 | 运营商返回的代码,如:"DB:0103" |
| errorDetail | string | 否 | 运营商反馈代码的中文解释,如使用该字段遇到问题请联系客服 |
| receiveTime | string | 否 | 到达时间 格式 yyyy-MM-dd HH:mm:ss |
重要说明#
请按照如下顺序使用参数
- 请先使用 reportState 判断接收状态;如果是"SUCCESS",为接收成功;如果是"FAIL",为接收失败;
- 如果接收状态失败,可以参考errorDetail 以及 errorState 来获取更详细信息;特别注意,这两个字段为解释型字段,请不要依据这两个字段判断接收状态;
- 请妥善保存推送信息;
- 如果您的系统接收推送信息失败,请及时联系我们。
Json响应示例#
[ { "errorDetail": "接收成功", "sid": 9527, "busId": "1234567", "errorState": "DELIVRD", "mobile": "18105201314", "reportState": "SUCCESS", "receiveTime": "2023-06-09 00:58:36" }, { "errorDetail": "接收成功", "sid": 9528, "busId": "12345678", "errorState": "DELIVRD", "mobile": "18112341234", "reportState": "SUCCESS" }, { "errorDetail": "接收成功", "sid": 9529, "busId": "abcdefg", "errorState": "DELIVRD", "mobile": "18112341234", "reportState": "SUCCESS" }]