获取状态报告
功能说明:
开通此接口功能后,我们将为您独立再保存一份新生产的状态报告数据,保存时间为72小时。 您可以通过此接口获取新产生的状态报告。注意,已成功获取的数据将会删除,请妥善处理接口返回的数据。
备注:
- 该接口为高级接口,默认不开放,可以在云片用户后台开启。
- 建议使用单线程获取。获取数据后,建议根据sid做去重。
HTTP头信息:
Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;
请求
URL:https://sms.yunpian.com/v2/sms/pull_status.json
注意:海外服务器地址 us.yunpian.com
访问方式:POST
请求参数
参数名 | 类型 | 是否必须 | 描述 | 示例 |
apikey | string | 是 | 用户唯一标识,在账号设置-子帐号管理中查看 | 9b11127a9701975c734b8aee81ee3526 |
page_size | integer | 否 | 每页个数,最大100个,默认20个 | 20 |
响应参数
名称 | 类型 | 描述 |
error_detail | string | 运营商反馈代码的中文解释,如使用该字段遇到问题请联系客服 |
sid | long(64位) | 短信id,64位整型, 对应Java和C#的long,不可用int解析 |
uid | string | 用户自定义id |
user_receive_time | string | 用户接收时间 |
error_msg | string | 运营商返回的代码,如:"DB:0103" |
mobile | string | 接收手机号 |
report_status | string | 接收状态有: "SUCCESS"/ "FAIL" |
重要说明
请按照如下顺序使用参数
- 请先使用 report_status 判断接收状态;如果是"SUCCESS",为接收成功;如果是"FAIL",为接收失败;
- 如果接收状态失败,可以参考error_detail 以及 error_msg 来获取更详细信息;特别注意,这两个字段为解释型字段,请不要依据这两个字段判断接收状态;
- 请妥善保存推送信息;
- 如果您的系统接收推送信息失败,请及时联系我们。
###Json响应示例
[
{
"error_detail": "接收成功",
"sid": 9527,
"uid": "1234567",
"user_receive_time": "2014-03-17 22:55:21",
"error_msg": "DELIVRD",
"mobile": "15205201314",
"report_status": "SUCCESS"
},
{
"sid": 9528,
"user_receive_time": "2014-03-17 22:55:23",
"error_msg": "DELIVRD",
"mobile": "15212341234",
"report_status": "SUCCESS"
},
{
"error_detail": "接收成功",
"sid": 9529,
"uid": "abcdefg",
"user_receive_time": "2014-03-17 22:55:23",
"error_msg": "DELIVRD",
"mobile": "15212341234",
"report_status": "SUCCESS"
}
]