Skip to main content

获取状态报告

功能说明:#

状态报告数据,保存时间为三个月。 您可以通过此接口获取新产生的状态报告。注意,已成功获取的数据将会删除,请妥善处理接口返回的数据。

备注:#

  • 建议使用单线程获取。获取数据后,建议根据sid做去重。
  • 如果配置了推送状态报告模式,该接口将获取不到状态报告

HTTP头信息(具体参考调用说明):#

    Accept:application/json;charset=utf-8;    Content-Type:application/json;charset=utf-8;    X-SIGNATURE: $signature;    X-APIKEY: $APIKEY;    X-TIMESTAMP: $timestamp;    X-NONCE: $nonce;

请求#

    URL:https://gateway.yihuitong.top/openapi/sms/pullStatus    访问方式:GET

请求参数#

参数名类型是否必传描述示例
pageSizeinteger每页个数,最大1000个,默认100个100

响应参数#

名称类型描述
successboolean是否请求成功 false 为接口请求失败,请求失败 data 中无数据
errorCodestring错误码 200 代表成功
errorMessagestring错误提示
dataobject[]报告数据,是一个数组;格式参考下面

data 响应参数#

名称类型是否必传描述
mobilestring接收手机号
sidlong(64 位)sid 发送接口返回的参数
busIdstring您上送的业务系统内的 ID
reportStatestring接收状态有: "SUCCESS"/ "FAIL"
errorStatestring运营商返回的代码,如:"DB:0103"
errorDetailstring运营商反馈代码的中文解释,如使用该字段遇到问题请联系客服
receiveTimestring到达时间 格式 yyyy-MM-dd HH:mm:ss
重要说明#

请按照如下顺序使用参数

  1. 请先使用 reportState 判断接收状态;如果是"SUCCESS",为接收成功;如果是"FAIL",为接收失败;
  2. 如果接收状态失败,可以参考errorDetail 以及 errorState 来获取更详细信息;特别注意,这两个字段为解释型字段,请不要依据这两个字段判断接收状态;
  3. 请妥善保存推送信息;
  4. 如果您的系统接收推送信息失败,请及时联系我们。
Json响应示例#
{     "success": true,    "errorCode": "200",    "errorMessage": "成功",    "data": [        {            "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"        }    ]}