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 請求。
備注:
- 該接口為高級接口,需要自行在后臺 "超級短信設置 - 數(shù)據(jù)推送設置" 中開啟。您可以設置固定的callback url 地址,也可以在每次發(fā)送請求中攜帶callback url 地址。我們會優(yōu)先向發(fā)送請求中攜帶的callback url 地址推送。
- 該接口一次最多推送100個狀態(tài)報告,為不影響推送速度,建議先接受數(shù)據(jù)后再做異步處理。
- 所有帶+86前綴的號碼都會去掉+86。
- 接收到數(shù)據(jù)后,請從參數(shù)sms_status中取值,取到值使用urldecode解碼后為實際json格式數(shù)據(jù)處理(部分語言由于解碼方式差異需要解碼兩次)。
- 處理成功請返回字符串"SUCCESS"或"0",其他返回值將被認為是失敗。
- 本接口有重新推送機制:第一次推送失敗后,間隔 5 分鐘重推一次。如果推送 3 次后仍失敗,不再重試。
請求參數(shù)
sms_status | string | 是 | 經(jīng)過urlencode編碼的數(shù)據(jù)形式如:sms_status=urlencode(json) |
參數(shù)名 | 類型 | 是否必須 | 描述 |
具體詳解:
推送的數(shù)據(jù)格式:
<參數(shù)名>=<經(jīng)過urlencode編碼的數(shù)據(jù)>
例如:
sms_status=urlencode(json)
推送json參數(shù)
error_detail | string | 運營商反饋代碼的中文解釋,默認不推送此字段,如需推送,請聯(lián)系客服; | 接收成功 |
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,系統(tǒng)會在狀態(tài)報告中返回此字段 | 9b11127a9701975c |
report_status | string | 接收狀態(tài)有: "SUCCESS" / "FAIL“ | SUCCESS |
名稱 | 類型 | 描述 | 示例值 |
重要說明
請按照如下順序使用參數(shù)
- 請先使用 report_status 判斷接收狀態(tài);如果是"SUCCESS",為接收成功;如果是"FAIL",為接收失??;
- 如果接收狀態(tài)失敗,可以參考error_detail 以及 error_msg 來獲取更詳細信息;特別注意,這兩個字段為解釋型字段,請不要依據(jù)這兩個字段判斷接收狀態(tài);
- 請妥善保存推送信息;
- 如果您的系統(tǒng)接收推送信息失敗,請及時聯(lián)系我們。
其中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" } ]
服務端推送數(shù)據(jù)形式如下
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'