推送状态报告消息
更新时间:2023-10-31
1. 功能说明
开通此接口后,我们将为您实时推送最新的状态报告。您需要提供一个HTTP URL地址,接受HTTP POST请求。
1.1 功能要点
1.1.1 本功能默认不开启,如需开启请前往“系统设置→开发管理→接口设置→消息接收”页设置;
1.1.2 通过HTTP POST批量推送。一次最多推送100个状态报告,为不影响推送速度,建议先接收数据后再做异步处理;
1.1.3 同一条报告数据,只能被一种方式接收。如:已通过“获取状态报告”接口接收,则“推送状态报告”接口将不会推送;
1.1.4 系统仅校验返回值为字符串 SUCCESS。若返回值非 SUCCESS 或响应失败情况下,系统会进行重试推送;
1.1.5 重试推送:第一次推送失败后,间隔1分钟、5分钟、10分钟后会进行重推,直至推送成功为止。如果推送3次后仍失败,不再重试。
1.1.2 通过HTTP POST批量推送。一次最多推送100个状态报告,为不影响推送速度,建议先接收数据后再做异步处理;
1.1.3 同一条报告数据,只能被一种方式接收。如:已通过“获取状态报告”接口接收,则“推送状态报告”接口将不会推送;
1.1.4 系统仅校验返回值为字符串 SUCCESS。若返回值非 SUCCESS 或响应失败情况下,系统会进行重试推送;
1.1.5 重试推送:第一次推送失败后,间隔1分钟、5分钟、10分钟后会进行重推,直至推送成功为止。如果推送3次后仍失败,不再重试。
1.2 协议说明
参数 | 说明 |
协议 | HTTP + JSON |
编码 | UTF-8 |
2. 开启HTTP推送
2.1 打开并登录国阳云平台:http://www.guoyangyun.com/webx/user/auth/sign.htm。
2.2 在“接口设置”中,点击“消息接收” 标签页,进行开启/关闭HTTP批量推送,并填写“推送地址”如下图:
2.2 在“接口设置”中,点击“消息接收” 标签页,进行开启/关闭HTTP批量推送,并填写“推送地址”如下图:
2.3 设置推送地址后,点击“测试推送”,系统会往推送地址发送一条测试数据,可以自行测试是否正确收取,如下图:
3. 请求说明
3.1 HTTP头信息
Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;
3.2 请求格式
URL:http://your_receive_url_address
访问方式:POST
访问方式:POST
3.3 请求参数(Body)
推送内容为JSON格式的List字符串,参数放在Body里传输,回执消息不区分群发或单发,单次请求可能会包含多个状态报告结果。
参数 | 名称 | 类型 | 描述 |
状态报告信息 | List | 状态报告详细信息 | |
receiveStatus | 发送状态 | String | 状态0表示发送成功,其他表示失败 |
smsid | 消息ID | String | 发送短信时,系统返回(或者自己指定)的消息ID |
mobile | 手机号码 | String | 发送的手机号码 |
receiveCode | 状态码 | String | 运营商网关返回的发送状态码。 |
reportTime | 报告时间 | String | 状态报告返回时间 |
desc | 状态描述 | String | 状态码对应的详细描述 |
重要说明:
● 请先使用receiveStatus判断发送状态,如果是0为发送成功,否则为发送失败;
● 如果状态失败,可以参考receiveCode以及desc来获取更详细信息;
● 特别注意,这两个字段为解释型字段,请不要依据这两个字段判断接收状态。
● 请先使用receiveStatus判断发送状态,如果是0为发送成功,否则为发送失败;
● 如果状态失败,可以参考receiveCode以及desc来获取更详细信息;
● 特别注意,这两个字段为解释型字段,请不要依据这两个字段判断接收状态。
3.4 数据JSON样例
[
{
"receiveStatus":"0",
"smsid":"155262931459818111848220",
"mobile":"19000000000",
"receiveCode":"DELIVRD"
"reportTime":"2019-03-15 13:55:16",
"desc":"发送成功"
},
{
"receiveStatus":"1",
"smsid":"155262931459818111848221",
"mobile":"18000000000",
"receiveCode":"MN:0000",
"reportTime":"2019-03-15 13:55:16",
"desc":"空号"
}
]
4. 响应说明
4.1 响应样例
SUCCESS
说明:系统仅校验返回值是否为字符串SUCCESS,若返回值非SUCCESS或响应失败情况下,系统会进行重试推送。
5. 重新推送
第一次推送失败后,间隔1分钟、5分钟、10分钟后会进行重推,直至推送成功为止。如果推送3次后仍失败,不再重试。