定時短信下行
1. 請求
(1) 請求地址:
https://u.smsyun.cc/sms-partner/access/{用戶帳號}/sendsms
注意:為了確保數(shù)據(jù)隱私和安全,用戶需要通過Https Post方式請求,消息格式:json表達式。
(2) Https標準包頭字段:
Accept:application/json;
Content-Type:application/json;charset=utf-8;
(3) 請求包體:
屬性 | 類型 | 約束 | 說明 |
clientid | String | 必選 | 帳號,6位, 如:a00012,b00012 |
password | String | 必選 | 密碼,8-12位,MD5加密后32位,小寫, 如:1bbd886460827015e5d605ed44252251 |
mobilelist | String | 必選 | 發(fā)送手機號碼, 國內(nèi)短信不要加前綴,國際短信號碼前須帶相應(yīng)的國家區(qū)號,如日本:0081, 支持多號碼,號碼之間用英文逗號隔開,最多10萬個。 國內(nèi)手機號碼如:18612341234 國際號碼如:0085265656565 拼接起來以后用compress_type中指定的壓縮類型壓縮,然后用base64編碼壓縮后的數(shù)據(jù) |
smstype | String | 必選 | 短信類型, "0":通知短信,"4":驗證碼短信,"5":營銷短信 |
content | String | 必選 | 【簽名】+ 短信內(nèi)容,UTF-8編碼, 短信內(nèi)容最長500個字(包括英文字母),其中簽名2-12個字(包括英文字母) |
sendtime | String | 必選 | 定時發(fā)送時間, 定時發(fā)送格式2016-11-11 09:00:00, 定時發(fā)送時間距當前時間應(yīng)該大于5分鐘以上 |
extend① | String | 可選 | 自擴展端口, 1-4位,只能為數(shù)字,可以為空 (注:請先詢問配置的通道是否支持自擴展端口,如果不支持,請?zhí)羁? |
uid② | String | 可選 | 用戶透傳ID, 隨狀態(tài)報告返回,最長60位 |
compress_type | String | 可選 | 默認為gzip壓縮 "0": gzip壓縮 |
注:
① extend字段用于客戶傳送由客戶自行分配給子客戶的擴展端口,用于上行短信回來與之對應(yīng)。
如:某客戶下有A、B、C三個子客戶,并且該客戶獲得某通道兩位自擴展,分別對其子客戶自行分配的擴展端口依次為子客戶A:01,子客戶B:02,子客戶C:03。
若子客戶A在發(fā)送下行短信時將該擴展端口01填入此字段即可,上行短信將會把此字段的擴展端口01發(fā)給客戶,用于客戶區(qū)分哪個子客戶的上行短信,子客戶A可根據(jù)上行短信中的電話號碼對應(yīng)之前的下行手機號碼;
② uid字段用戶在單、群發(fā)短信時,由用戶生成并下發(fā)到平臺的序列號(最長不超過60位),該uid將在應(yīng)答、狀態(tài)報告中返回給客戶,用于客戶區(qū)分或?qū)?yīng)單、群發(fā)短信的批次。
定時短信一次最多設(shè)置10萬個號碼(目前不支持多內(nèi)容組發(fā))。
(4) JSON請求示例:
{
"clientid":"test",
"password":"6918d0046aab6a1ee290f751e02bd0b2",
"mobilelist":"H4sICGUEPloAA3Bob25lLmxpc3QATdo7bmNJEEXBDbUxWZW/2v/GmmxgwJCjpPD0rncMIuK/fz….",
"smstype":"4",
"content":"【云通訊】您的驗證碼為:1234",
"sendtime":"2018-11-11 09:00:00",
"extend":"00",
"uid":"00",
"compress_type":"0"
}
2. 響應(yīng)
(1) 響應(yīng)包體:
屬性 | 類型 | 約束 | 說明 |
total_fee① | Int | 必選 | 短信發(fā)送的計費總條數(shù) |
sid2 | String | 必選 | 短信標識符(sid + 手機號用于匹配狀態(tài)報告), 一批定時短信手機號對應(yīng)一個sid |
uid3 | String | 可選 | 用戶透傳ID, 隨狀態(tài)報告返回 |
comporess_type | String | 可選 | 返回號碼列表使用的壓縮算法。 默認gzip: 0: gzip |
data | 發(fā)送的詳細情況 | ||
code | Int | 必選 | 短信請求響應(yīng)返回碼, 參考“請求響應(yīng)返回碼”定義的返回碼 (詳見第九章第1節(jié)) |
msg | String | 必選 | 短信請求響應(yīng)返回中文描述, 參考“請求響應(yīng)返回碼”定義的中文描述 (詳見第九章第1節(jié)) |
mobilelist | String | 可選 | 當code=-7或code=-30時存在,表示code對應(yīng)的號碼列表(同樣使用compress_type指定類型壓縮+base64編碼); code為其它時無此域 |
mobilecnt | Int | 可選 | 當code=0或code=-7或code=-30時存在,表示code對應(yīng)的號碼個數(shù); code為其它時無此域 |
注:
① total_fee表示單(群)發(fā)短(長)短信總共計費的條數(shù),該條數(shù)等于單條短信計費條數(shù)X所有成功返回的號碼數(shù);
② sid是短信平臺產(chǎn)生的唯一標示,與后面返回的狀態(tài)報告中的sid+手機號一一對應(yīng),用于下發(fā)短息與狀態(tài)報告相對應(yīng);
③ uid字段返回內(nèi)容和第一章第1節(jié)請求中的“用戶透傳ID”一致,用于客戶區(qū)分或?qū)?yīng)單、群發(fā)短信的批次;
(2) JSON響應(yīng)示例
{
"total_fee":200,
"sid":"08faf6-5728-438d-95ed-e0e0cec4fd37",
"uid":"1234",
"data":[
{
"code":0,
"msg":"發(fā)送成功",
"mobilecnt":200
},
{
"code":-7,
"msg":"手機號碼格式錯誤",
"mobilelist":"H4sICGUEPloAA3Bob25lLmxp….",
"mobilecnt":4
}
]
}
包頭/包體 | 實例 | 備注 |
Header | HTTP/1.1 200 OK Accept-Encoding:identity Content-Length:424 Host:172.16.5.21:45302 Accept:application/json Content-Type:application/json;charset=utf-8 | 藍色字體為可變部分 |
Body | {"total_fee":200,"sid":"08faf6-5728-438d-95ed-e0e0cec4fd37","uid":"1234",data":[{"code":0,"msg":"發(fā)送成功", "mobilecnt":200},{"code":-7,"msg": "手機號碼格式錯誤","fee":0,"mobilelist":"1843123454,1843123454,22344433,21822222","mobilecnt":4]} | 藍色字體為可變部分 |