推送狀態(tài)報(bào)告
功能說明:開通此接口后,我們將為您實(shí)時(shí)推送最新的狀態(tài)報(bào)告。您需要提供一個(gè)callback url地址,接受http post請(qǐng)求。 該接口一次最多推送100個(gè)狀態(tài)報(bào)告,為不影響推送速度,建議先接受數(shù)據(jù)后再做異步處理。
備注:
- 本功能默認(rèn)不開啟,如需開啟請(qǐng)前往“系統(tǒng)設(shè)置-數(shù)據(jù)獲取與推送”頁設(shè)置。您可以設(shè)置固定的callback url 地址,也可以在每次發(fā)送請(qǐng)求中攜帶callback url 地址。我們會(huì)優(yōu)先向發(fā)送請(qǐng)求中攜帶的callback url 地址推送。
- 所有帶+86前綴的號(hào)碼都會(huì)去掉+86
- 接收到數(shù)據(jù)后,請(qǐng)從參數(shù)sms_status中取值,取到值使用urldecode解碼后為實(shí)際json格式數(shù)據(jù)(部分語言由于解碼方式差異需要解碼兩次)處理成功請(qǐng)返回字符串"SUCCESS"或"0",其他返回值將被認(rèn)為是失敗。該接口失敗重試次數(shù)為3次,每次間隔5分鐘。
- 獲取數(shù)據(jù)后,建議根據(jù)sid做去重。
HTTP頭信息:
Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;
請(qǐng)求
URL:http://your_receive_url_address
注意:海外服務(wù)器地址 us.yunpian.com
訪問方式:POST
請(qǐng)求參數(shù)
參數(shù)名 | 類型 | 是否必須 | 描述 |
sms_status | string | 是 | 經(jīng)過urlencode編碼的數(shù)據(jù)形式如:sms_status=urlencode(json) |
具體詳解:
推送的數(shù)據(jù)格式:
<參數(shù)名>=<經(jīng)過urlencode編碼的數(shù)據(jù)>
例如:
sms_status=urlencode(json)
服務(wù)端推送數(shù)據(jù)形式如下:
curl --data "sms_status=url_encode_json" http://your_receive_url_address
推送json參數(shù)
名稱 | 類型 | 描述 |
error_detail | string | 運(yùn)營(yíng)商反饋代碼的中文解釋,如使用該字段遇到問題請(qǐng)聯(lián)系客服 |
sid | long(64位)是 | 短信id,64位整型, 對(duì)應(yīng)Java和C#的long,不可用int解析 |
uid | string | 用戶自定義id |
user_receive_time | string | 用戶接收時(shí)間 |
error_msg | string | 運(yùn)營(yíng)商返回的代碼,如:"DB:0103";由于不同運(yùn)營(yíng)商信息不同,此字段僅供參考; |
mobile | string | 接收手機(jī)號(hào) |
report_status | string | 接收狀態(tài)有: "SUCCESS" / "FAIL“ |
重要說明
請(qǐng)按照如下順序使用參數(shù)
- 請(qǐng)先使用 report_status 判斷接收狀態(tài);如果是"SUCCESS",為接收成功;如果是"FAIL",為接收失??;
- 如果接收狀態(tài)失敗,可以參考error_detail 以及 error_msg 來獲取更詳細(xì)信息;特別注意,這兩個(gè)字段為解釋型字段,請(qǐng)不要依據(jù)這兩個(gè)字段判斷接收狀態(tài);
- 請(qǐng)妥善保存推送信息;
- 如果您的系統(tǒng)接收推送信息失敗,請(qǐng)及時(shí)聯(lián)系我們。
其中json示例
[
{
"error_detail": "接收成功",
"sid": 9527,
"uid": "1234567",
"user_receive_time": "2014-03-17 22:55:21",
"error_msg": "DELIVRD",
"mobile": "15205201314",
"report_status": "SUCCESS"
},
{ "error_detail": "空號(hào)、停機(jī)或關(guān)機(jī)",
"sid": 9528,
"uid": "121",
"user_receive_time": "2014-03-17 22:55:23",
"error_msg": "MI:0024",
"mobile": "15212341235",
"report_status": "FAIL"
},
{
"error_detail": "接收成功",
"sid": 9529,
"uid": "abcdefg",
"user_receive_time": "2014-03-17 22:55:23",
"error_msg": "DELIVRD",
"mobile": "15212341234",
"report_status": "SUCCESS"
}
]