HTTP 头信息


Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;


请求

URL: http://your_recieve_url_address

访问方式: POST

功能说明:开通此接口后,我们将为您实时推送短信报告。您需要提供一个 callback url 地址,接收 http POST 请求。

备注:

  • 该接口为高级接口,需要自行在后台 "超级短信设置 - 数据推送设置" 中开启。您可以设置固定的callback url 地址,也可以在每次发送请求中携带callback url 地址。我们会优先向发送请求中携带的callback url 地址推送。
  • 该接口一次最多推送100个状态报告,为不影响推送速度,建议先接受数据后再做异步处理。
  • 所有带+86前缀的号码都会去掉+86。
  • 接收到数据后,请从参数sms_status中取值,取到值使用urldecode解码后为实际json格式数据处理(部分语言由于解码方式差异需要解码两次)。
  • 处理成功请返回字符串"SUCCESS"或"0",其他返回值将被认为是失败。
  • 本接口有重新推送机制:第一次推送失败后,间隔 5 分钟重推一次。如果推送 3 次后仍失败,不再重试。


请求参数

sms_status

string

经过urlencode编码的数据形式如:sms_status=urlencode(json)

参数名

类型

是否必须

描述

具体详解:

推送的数据格式:

<参数名>=<经过urlencode编码的数据>


例如:

sms_status=urlencode(json)

推送json参数

error_detail

string

运营商反馈代码的中文解释,默认不推送此字段,如需推送,请联系客服;

接收成功

sid

long(64位)

短信id,64位整型, 对应Java和C#的long,不可用int解析;

9529

user_receive_time

string

用户接收时间,格式: yyyy-MM-dd HH:mm:ss;

2020-03-16 22:55:23

error_msg

string

运营商返回的代码,如:"DB:0103";由于不同运营商信息不同,此字段仅供参考;

DB:0103

mobile

string

接收手机号;

15212341234

uid

string

用户自定义的 uid,系统会在状态报告中返回此字段

9b11127a9701975c

report_status

string

接收状态有: "SUCCESS" / "FAIL“

SUCCESS

名称

类型

描述

示例值


重要说明

请按照如下顺序使用参数

  1. 请先使用 report_status 判断接收状态;如果是"SUCCESS",为接收成功;如果是"FAIL",为接收失败;
  2. 如果接收状态失败,可以参考error_detail 以及 error_msg 来获取更详细信息;特别注意,这两个字段为解释型字段,请不要依据这两个字段判断接收状态;
  1. 请妥善保存推送信息;
  2. 如果您的系统接收推送信息失败,请及时联系我们。

其中json示例

[
    {
        "error_detail": "接收成功",
        "sid": 9527,
        "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,
        "user_receive_time": "2014-03-17 22:55:23",
        "error_msg": "DELIVRD",
        "mobile": "15212341234",
        "report_status": "SUCCESS"
    }
]


服务端推送数据形式如下

curl -X POST \
http://your_recieve_url_address \
-H 'Accept: application/json;charset=utf-8;' \
-H 'Content-Type: application/x-www-form-urlencoded;' \
-H 'cache-control: no-cache' \
-d 'sms_status=xxxxxxx'