短信平臺(tái)接口規(guī)范

《短信平臺(tái)接口規(guī)范》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在應(yīng)用文檔-天天文庫。

1、短信平臺(tái)接口說明17目錄1普通短信發(fā)送41.1接口地址41.2參數(shù)定義41.3短信提交響應(yīng)51.3.1文本格式說明51.3.2JSON格式說明61.3.3響應(yīng)狀態(tài)值說明61.4注意事項(xiàng)71.5短信發(fā)送例子72變量短信發(fā)送72.1接口地址82.2參數(shù)定義82.3提交響應(yīng)92.3.1文本格式說明92.3.2JSON格式說明92.3.3響應(yīng)狀態(tài)值說明102.4示例103短信包發(fā)送103.1接口地址103.2參數(shù)定義103.3提交響應(yīng)113.3.1文本格式說明113.3.2JSON格式說明123.3.3響應(yīng)狀態(tài)值說

2、明123.4示例124狀態(tài)報(bào)告推送134.1參數(shù)定義134.2狀態(tài)報(bào)告值134.3示例145狀態(tài)報(bào)告批量推送145.1參數(shù)定義145.2示例156短信接收156.1參數(shù)定義156.2示例157額度查詢接口167.1接口地址167.2參數(shù)定義167.3提交響應(yīng)16177.4提交響應(yīng)值167.5示例178附錄1717本文檔主要定了短信平臺(tái)對(duì)用戶開放的主要接口和定義。1普通短信發(fā)送用戶通過HTTP的POST方式提交短信發(fā)送請(qǐng)求。短信發(fā)送接口，區(qū)分為短信單發(fā)和短信群發(fā)兩個(gè)接口。建議都使用群發(fā)接口1.1接口地址短信提

3、交分為單發(fā)和群發(fā)（賬戶是否具有單發(fā)和群發(fā)的功能需要管理員進(jìn)行功能的開通）。單發(fā)只能提交單個(gè)手機(jī)號(hào)碼，群發(fā)可以提交不超過50000個(gè)手機(jī)號(hào)碼，每個(gè)號(hào)碼用英文逗號(hào)間隔。區(qū)別單發(fā)和群發(fā)主要在于發(fā)送的接口URL地址入口不同。群發(fā)的URL地址為：http://116.62.205.143:80/msg/HttpBatchSendSM。注：其中IP:PORT為服務(wù)部署的地址和端口。1.2參數(shù)定義序號(hào)參數(shù)說明1account必填參數(shù)。用戶賬號(hào)2ts可選參數(shù)，時(shí)間戳，格式y(tǒng)yyyMMddHHmmss3pswd必填參數(shù)。用戶

4、密碼，ts參數(shù)為空時(shí)填明文密碼，ts參數(shù)不為空時(shí)填md5(賬號(hào)+密碼+時(shí)間戳)，對(duì)賬號(hào)密碼時(shí)間戳拼接的字符串進(jìn)行md5加密4mobile必填參數(shù)。合法的手機(jī)號(hào)碼，號(hào)碼間用英文逗號(hào)分隔5msg必填參數(shù)。短信內(nèi)容，長(zhǎng)度不能超過700個(gè)字符。使用URL方式編碼為UTF-8格式。短信內(nèi)容超過70個(gè)字符時(shí)，會(huì)被拆分成多條，然后以長(zhǎng)短信的格式發(fā)送。6needstatus必填參數(shù)。是否需要狀態(tài)報(bào)告，取值true或false，true，表明需要狀態(tài)報(bào)告；false不需要狀態(tài)報(bào)告7product17可選參數(shù)。用戶訂購的產(chǎn)品i

5、d，不填寫時(shí)使用用戶的默認(rèn)產(chǎn)品，用戶訂購多個(gè)產(chǎn)品時(shí)必填，否則會(huì)發(fā)生計(jì)費(fèi)錯(cuò)誤。8extno可選參數(shù)，擴(kuò)展碼，用戶自定義擴(kuò)展碼9resptype可選參數(shù)，響應(yīng)格式，默認(rèn)返回文本格式，填json返回json格式1.1短信提交響應(yīng)用戶短信通過http請(qǐng)求提交到服務(wù)器后，服務(wù)器返回響應(yīng)1.1.1文本格式說明格式如下resptime,respstatusmsgid短信提交響應(yīng)分為兩行（每行以換行符(0x0a,即)分割），第一行為響應(yīng)時(shí)間和狀態(tài)，第二行為服務(wù)器給出提交msgid，一個(gè)發(fā)送請(qǐng)求只返回一個(gè)msgid。如果

6、響應(yīng)的狀態(tài)不是“0”，或者提交時(shí)needstatus不等于true，則沒有msgid，即第二行數(shù)據(jù)為空。?提交成功20110725160412,01234567890100響應(yīng)時(shí)間為20110725160412，響應(yīng)狀態(tài)為0表明成功提交到服務(wù)器；1234567890100為返回的msgid，供狀態(tài)報(bào)告匹配時(shí)使用。?提交失敗20110725160412,10117本示例表明用戶提交失敗，返回錯(cuò)誤碼為101，服務(wù)器端并未返回msgid。1.1.1JSON格式說明{"ts":"20110725160412","r

7、esult":0,"msgid":"1234567890100"}ts為響應(yīng)時(shí)間，result為響應(yīng)狀態(tài)（0表示成功，其他表示失?。琺sgid為狀態(tài)匹配使用（如果響應(yīng)的狀態(tài)不是0，或者提交時(shí)needstatus不等于true，則沒有msgid字段）1.1.2響應(yīng)狀態(tài)值說明代碼說明0提交成功101無此用戶102密碼錯(cuò)103提交過快（提交速度超過流速限制）104系統(tǒng)忙（因平臺(tái)側(cè)原因，暫時(shí)無法處理提交的短信）105敏感短信（短信內(nèi)容包含敏感詞）106消息長(zhǎng)度錯(cuò)（>700或<=0）107包含錯(cuò)誤的手機(jī)號(hào)碼108手

8、機(jī)號(hào)碼個(gè)數(shù)錯(cuò)（群發(fā)>50000或<=0;單發(fā)>200或<=0）109無發(fā)送額度（該用戶可用短信數(shù)已使用完）110不在發(fā)送時(shí)間內(nèi)111超出該賬戶當(dāng)月發(fā)送額度限制112無此產(chǎn)品，用戶沒有訂購該產(chǎn)品113extno格式錯(cuò)（非數(shù)字或者長(zhǎng)度不對(duì)）115自動(dòng)審核駁回116簽名不合法，未帶簽名（用戶必須帶簽名的前提下）11717IP地址認(rèn)證錯(cuò),請(qǐng)求調(diào)用的IP地址不是系統(tǒng)登記的IP地址118用戶沒有相應(yīng)的發(fā)送權(quán)限119用戶已過期