短信下行
1. 請(qǐng)求
(1) 請(qǐng)求地址:
https://u.smsyun.cc/sms-partner/access/{用戶帳號(hào)}/sendsms
注意:為了確保數(shù)據(jù)隱私和安全,用戶需要通過(guò)Https Post方式請(qǐng)求,消息格式:json表達(dá)式。
(2) Https標(biāo)準(zhǔn)包頭字段:
Accept:application/json;
Content-Type:application/json;charset=utf-8;
(3) 請(qǐng)求包體:
屬性 | 類型 | 約束 | 說(shuō)明 |
clientid | String | 必選 | 帳號(hào),6位, 如:a00012,b00012 |
password | String | 必選 | 密碼,8-12位,MD5加密后32位,小寫(xiě), 如:1bbd886460827015e5d605ed44252251 |
mobile | String | 必選 | 發(fā)送手機(jī)號(hào)碼, 國(guó)內(nèi)短信不要加前綴,國(guó)際短信號(hào)碼前須帶相應(yīng)的國(guó)家區(qū)號(hào),如日本:0081, 支持多號(hào)碼,號(hào)碼之間用英文逗號(hào)隔開(kāi),最多100個(gè)。 國(guó)內(nèi)手機(jī)號(hào)碼如:18612341234 國(guó)際號(hào)碼如:0085265656565 |
smstype | String | 必選 | 短信類型, "0":通知短信,"4":驗(yàn)證碼短信,"5":營(yíng)銷短信 |
content | String | 必選 | 【簽名】+ 短信內(nèi)容,UTF-8編碼, 短信內(nèi)容最長(zhǎng)500個(gè)字(包括英文字母),其中簽名2-12個(gè)字(包括英文字母) |
sendtime | String | 可選 | 定時(shí)發(fā)送時(shí)間, 為空表示立即發(fā)送,定時(shí)發(fā)送格式2016-11-11 09:00:00 (未生效) |
extend① | String | 可選 | 自擴(kuò)展端口, 1-4位,只能為數(shù)字,可以為空 (注:請(qǐng)先詢問(wèn)配置的通道是否支持自擴(kuò)展端口,如果不支持,請(qǐng)?zhí)羁? |
uid② | String | 可選 | 用戶透傳ID, 隨狀態(tài)報(bào)告返回,最長(zhǎng)60位 |
注:
① extend字段用于客戶傳送由客戶自行分配給子客戶的擴(kuò)展端口,用于上行短信回來(lái)與之對(duì)應(yīng)。
如:某客戶下有A、B、C三個(gè)子客戶,并且該客戶獲得某通道兩位自擴(kuò)展,分別對(duì)其子客戶自行分配的擴(kuò)展端口依次為子客戶A:01,子客戶B:02,子客戶C:03。
若子客戶A在發(fā)送下行短信時(shí)將該擴(kuò)展端口01填入此字段即可,上行短信將會(huì)把此字段的擴(kuò)展端口01發(fā)給客戶,用于客戶區(qū)分哪個(gè)子客戶的上行短信,子客戶A可根據(jù)上行短信中的電話號(hào)碼對(duì)應(yīng)之前的下行手機(jī)號(hào)碼;
② uid字段用戶在單、群發(fā)短信時(shí),由用戶生成并下發(fā)到平臺(tái)的序列號(hào)(最長(zhǎng)不超過(guò)60位),該uid將在應(yīng)答、狀態(tài)報(bào)告中返回給客戶,用于客戶區(qū)分或?qū)?yīng)單、群發(fā)短信的批次。
群發(fā)一次最多100個(gè)號(hào)碼(目前不支持多內(nèi)容組發(fā))。
(4) JSON請(qǐng)求示例:
{
"clientid":"test",
"password":"6918d0046aab6a1ee290f751e02bd0b2",
"mobile":"13800138000,13800138001,19800138002,19800138003",
"smstype":"4",
"content":"【云通訊】您的驗(yàn)證碼為:1234",
"sendtime":"2016-11-11 09:00:00",
"extend":"00",
"uid":"00"
}
包頭/包體 | 實(shí)例 | 備注 |
Header | POST /sms-partner/access/test/sendsms HTTP/1.1 Accept-Encoding:identity Content-Length:191 Host:172.16.5.20:9999 Accept:application/json Content-Type:application/json;charset=utf-8 | 藍(lán)色字體為可變部分, 保證路徑正確,采用HTTPS的POST方式發(fā)送; |
Body | {"clientid":"test","password":"6918d0046aab6a1ee290f751e02bd0b2","mobile":"13800138000,13800138001,19800138002,19800138003","smstype":"4","content":"【云通訊】您的驗(yàn)證碼為1234","sendtime":"2016-11-11 09:00:00","extend":"00","uid":"00"} | 藍(lán)色字體為可變部分 |
2. 響應(yīng)
(1) 響應(yīng)包體:
屬性 | 類型 | 約束 | 說(shuō)明 |
total_fee | Int | 必選 | 短信發(fā)送的計(jì)費(fèi)總條數(shù) |
data | 每個(gè)手機(jī)號(hào)發(fā)送的詳細(xì)情況 | ||
code | Int | 必選 | 短信請(qǐng)求響應(yīng)返回碼,參考“請(qǐng)求響應(yīng)返回碼”定義的返回碼 (詳見(jiàn)第九章第1節(jié)) |
msg | String | 必選 | 短信請(qǐng)求響應(yīng)返回中文描述,參考“請(qǐng)求響應(yīng)返回碼”定義的中文描述(詳見(jiàn)第九章第1節(jié)) |
fee | Int | 必選 | 成功發(fā)送的短信計(jì)費(fèi)條數(shù),計(jì)費(fèi)規(guī)則如下:70個(gè)字一條,超出70個(gè)字時(shí)按每67字一條計(jì)費(fèi)(英文按字母?jìng)€(gè)數(shù)計(jì)算) |
mobile | String | 必選 | 接收短信的手機(jī)號(hào)碼 |
sid | String | 必選 | 短信標(biāo)識(shí)符(用于匹配狀態(tài)報(bào)告),一個(gè)手機(jī)號(hào)對(duì)應(yīng)一個(gè)sid |
uid | String | 可選 | 用戶透傳ID,隨狀態(tài)報(bào)告返回 |
注:
① total_fee表示單(群)發(fā)短(長(zhǎng))短信總共計(jì)費(fèi)的條數(shù),該條數(shù)等于data域中各個(gè)fee字段數(shù)量之和;
② fee表示每個(gè)短信接收的手機(jī)號(hào)碼收到短信的計(jì)費(fèi)條數(shù)(長(zhǎng)短信按照短信計(jì)費(fèi)規(guī)則進(jìn)行計(jì)費(fèi),長(zhǎng)短信拆分最大不超過(guò)10條);
③ sid是短信平臺(tái)產(chǎn)生的唯一標(biāo)示,與后面返回的狀態(tài)報(bào)告中的sid一一對(duì)應(yīng),用于下發(fā)短息與狀態(tài)報(bào)告相對(duì)應(yīng);
④ uid字段返回內(nèi)容和第一章第1節(jié)請(qǐng)求中的“用戶透傳ID”一致,用于客戶區(qū)分或?qū)?yīng)單、群發(fā)短信的批次;
(2) JSON響應(yīng)示例
{
"total_fee":2,
"data":[
{
"code":0,
"msg":"發(fā)送成功",
"fee":1,
"mobile":"13800138000",
"sid":"08faf6-5728-438d-95ed-e0e0cec4fd37",
"uid":"1234"
},
{
"code":0,
"msg":"發(fā)送成功",
"fee":1,
"mobile":"13800138001",
"sid":"09faf6-5728-838d-95ed-e0e0cec4fd39",
"uid":"1234"
},
{
"code":-7,
"msg":"手機(jī)號(hào)碼格式錯(cuò)誤"
"fee":0,
"mobile":"19800138002",
"sid":"753af6-5728-838d-95ed-e0e0cec4fd39",
"uid":"1234"
},
{
"code":-7,
"msg":"手機(jī)號(hào)碼格式錯(cuò)誤"
"fee":0,
"mobile":"19800138003",
"sid":"95sw6-5728-838d-95ed-e0e0cec4fd39",
"uid":"1234"
}
]
}
包頭/包體 | 實(shí)例 | 備注 |
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 | 藍(lán)色字體為可變部分 |
Body | {"total_fee":2,"data":[{"code":0,"msg":"發(fā)送成功","fee":1,"mobile":"13800138000","sid":"08faf6-5728-438d-95ed-e0e0cec4fd37"},{"code":0,"msg":"發(fā)送成功","fee":1,"mobile":"13800138001","sid":"09faf6-5728-838d-95ed-e0e0cec4fd39"},{"code":-7,"msg":"手機(jī)號(hào)碼格式錯(cuò)誤","fee":0, "mobile":"19800138002", "sid":"753af6-5728-838d-95ed-e0e0cec4fd39"}, {"code":-7,"msg":"手機(jī)號(hào)碼格式錯(cuò)誤","fee":0, "mobile":"19800138003","sid":"95sw6-5728-838d-95ed-e0e0cec4fd39","uid":"1234"}]} | 藍(lán)色字體為可變部分 |