企業(yè)短信http接口文檔2.0

《企業(yè)短信http接口文檔2.0》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在工程資料-天天文庫(kù)。

1、企業(yè)短信HTTP接口文檔2.0目錄1普通短信發(fā)送31.1短信接口地址31.2參數(shù)定義31.3短信提交響應(yīng)41.3.1格式說(shuō)明41.3.2示例41.3.3響應(yīng)狀態(tài)值說(shuō)明51.4注意事項(xiàng)61.5短信發(fā)送例子62狀態(tài)報(bào)告推送62.1參數(shù)定義72.2狀態(tài)報(bào)告值72.3示例73短信接收83.1參數(shù)定義83.2示例84額度查詢接口94.1接口地址94.2參數(shù)定義94.3提交響應(yīng)94.4提交響應(yīng)值94.5示例105附錄10本文檔主要定了短信平臺(tái)對(duì)用戶開(kāi)放的主要接口和定義。1短信發(fā)送用戶通過(guò)HTTP的POST方式提交短信發(fā)送請(qǐng)求。短信發(fā)送接口如下。1.1短信接口地址接

2、口：http://send.18sms.com/msg/HttpBatchSendSM。1.2參數(shù)定義序號(hào)參數(shù)說(shuō)明1account必填參數(shù)。用戶賬號(hào)2pswd必填參數(shù)。用戶密碼3mobile必填參數(shù)。合法的手機(jī)號(hào)碼4msg必填參數(shù)。短信內(nèi)容，驗(yàn)證碼短信內(nèi)容控制在70個(gè)字符內(nèi)。使用URL方式編碼為UTF-8格式。通知短信內(nèi)容超過(guò)70個(gè)字符時(shí)，會(huì)被拆分成多條，然后以長(zhǎng)短信的格式發(fā)送。5needstatus必填參數(shù)。是否需要狀態(tài)報(bào)告，取值true或false，true，表明需要狀態(tài)報(bào)告；false不需要狀態(tài)報(bào)告6product可選參數(shù)。用戶訂購(gòu)的產(chǎn)品id，不

3、填寫(xiě)（針對(duì)老用戶）系統(tǒng)采用用戶的默認(rèn)產(chǎn)品，用戶訂購(gòu)多個(gè)產(chǎn)品時(shí)必填，否則會(huì)發(fā)生計(jì)費(fèi)錯(cuò)誤。7extno請(qǐng)登陸網(wǎng)站用戶中心——>服務(wù)管理找到簽名對(duì)應(yīng)的extno并填寫(xiě)，線下用戶請(qǐng)為空。1.3短信提交響應(yīng)用戶短信通過(guò)http請(qǐng)求提交到服務(wù)器后，服務(wù)器返回響應(yīng)碼，響應(yīng)碼的格式如下：resptime,respstatusmsgid1.1.1格式說(shuō)明短信提交響應(yīng)分為兩行，第一行為響應(yīng)時(shí)間和狀態(tài)，第二行為服務(wù)器給出提交msgid。無(wú)論發(fā)送的號(hào)碼是多少，一個(gè)發(fā)送請(qǐng)求只返回一個(gè)msgid，如果響應(yīng)的狀態(tài)不是“0”，則沒(méi)有msgid即第二行數(shù)據(jù)。（每行以換行符(0x0a,即

4、)分割）注：needstatus參數(shù)需要等于true才會(huì)返回msgid1.1.2示例?提交成功20110725160412,01234567890100響應(yīng)時(shí)間為20110725160412，響應(yīng)狀態(tài)為0表明那個(gè)成功提交到服務(wù)器；1234567890100為返回的msgid，這個(gè)工狀態(tài)報(bào)告匹配時(shí)使用。20110725160412,101?提交失敗?本示例表明用戶提交失敗，返回錯(cuò)誤碼為101，服務(wù)器端并未返回msgid。1.1.1響應(yīng)狀態(tài)值說(shuō)明代碼說(shuō)明0提交成功101無(wú)此用戶102密碼錯(cuò)103提交過(guò)快（提交速度超過(guò)流速限制）104系統(tǒng)忙（因平臺(tái)側(cè)原因

5、，暫時(shí)無(wú)法處理提交的短信）105敏感短信（短信內(nèi)容包含敏感詞）106消息長(zhǎng)度錯(cuò)（>536或<=0）107包含錯(cuò)誤的手機(jī)號(hào)碼108手機(jī)號(hào)碼個(gè)數(shù)錯(cuò)（群發(fā)>50000或<=0）109無(wú)發(fā)送額度（該用戶可用短信數(shù)已使用完）110不在發(fā)送時(shí)間內(nèi)(驗(yàn)證碼通知7*24小時(shí)發(fā)送)111超出該賬戶當(dāng)月發(fā)送額度限制112無(wú)此產(chǎn)品，用戶沒(méi)有訂購(gòu)該產(chǎn)品113extno格式錯(cuò)（非數(shù)字或者長(zhǎng)度不對(duì)）115自動(dòng)審核駁回116簽名不合法，未帶簽名（用戶必須帶簽名的前提下）117IP地址認(rèn)證錯(cuò),請(qǐng)求調(diào)用的IP地址不是系統(tǒng)登記的IP地址118用戶沒(méi)有相應(yīng)的發(fā)送權(quán)限119用戶已過(guò)期120內(nèi)

6、容不在白名單中1.2注意事項(xiàng)用戶發(fā)短信必須提前報(bào)備短信內(nèi)容，如果發(fā)送未報(bào)備的內(nèi)容會(huì)進(jìn)入審核平臺(tái)，則客戶的短信必須經(jīng)過(guò)管理人員的審核，審核通過(guò)后才能被提交到行業(yè)網(wǎng)關(guān)進(jìn)行短信實(shí)際發(fā)送。用戶群發(fā)短信必須滿足手機(jī)號(hào)碼最低個(gè)數(shù)的限制，低于系統(tǒng)設(shè)定的群發(fā)最小手機(jī)號(hào)碼數(shù)，則該提交請(qǐng)求會(huì)被拒絕，響應(yīng)碼為108。1.1短信發(fā)送例子特別注意：請(qǐng)登陸網(wǎng)站用戶中心——>服務(wù)管理找到簽名對(duì)應(yīng)的extno并填寫(xiě)，線下用戶請(qǐng)為空。?短信發(fā)送http://send.18sms.com/msg/HttpBatchSendSM?account=003547&pswd=Sd123456&m

7、obile=15924188183&msg=您好，您的驗(yàn)證碼：1234&needstatus=true&extno=2狀態(tài)報(bào)告推送如果管理員設(shè)置用戶賬戶需要狀態(tài)報(bào)告，并且也配置了賬戶的狀態(tài)報(bào)告接收地址，則用戶可以接收到其發(fā)送短信的狀態(tài)報(bào)告。用戶側(cè)啟動(dòng)一個(gè)HTTP服務(wù)用于接收狀態(tài)報(bào)告。2.1參數(shù)定義序號(hào)參數(shù)說(shuō)明1receiver接收狀態(tài)報(bào)告驗(yàn)證的用戶名（不是賬戶名），是按照用戶要求配置的名稱，可以為空2pswd接收狀態(tài)報(bào)告驗(yàn)證的密碼，可以為空3msgid提交短信時(shí)平臺(tái)返回的msgid，參見(jiàn)1.24reportTime格式Y(jié)YMMDDhhmm，其中YY=年

8、份的最后兩位（00-99），MM=月份（01-12），DD=日（01-31），hh=小時(shí)（00