哲合通短信接口說明文檔.docx

1、哲合通短信接口說明文檔2015-12-28接口說明：接口編碼方式采用統(tǒng)一的UTF-8 ,請求方式采用HTTP REST ,支持GET/POST方式"list1':"flag": 0,"mid": "4C05","spid": "922011”,"mobile”: ","content":"上行內(nèi)容”，"lime": "2017-04-12 01:38:21"Fag": 1,"mi

2、d”: "4C06","spid”: "922011","mobile": ","stal”："測試內(nèi)曾，"time": "2017-04-12 01:38:21"字段說明status請求結(jié)果，具體參見STATUS錯誤代碼表balance當(dāng)前賬戶余額，單位厘list詳細(xì)狀態(tài)報(bào)告列表flag0=手機(jī)用戶上行mid消息1D（與提交時響應(yīng)的消息ID匹配）spid歸屬賬號（可忽略）mobile手機(jī)號碼accessCode接收號碼，即SP服務(wù)號（I06XXXXXX

3、）content手機(jī)上行的具體內(nèi)容lime手機(jī)上行的具體時間6.客戶端被動接收上行和狀態(tài)報(bào)告用于網(wǎng)關(guān)向客戶端推送狀態(tài)報(bào)告6.1 .請求地址由客戶端向網(wǎng)關(guān)報(bào)備推送地址，請求方式由網(wǎng)關(guān)采用POST方式，推送到客戶端6.2 .請求參數(shù)"flag": 0,"mid": "4C05","spid”: "922011”，"mobile": ","content”："上行內(nèi)容”，"time": "2017-04-12 01:38:21"&q

4、uot;flag": 1,"mid": "4C06","spid": "922011”,"mobile”:"stat": "DELIVRD","lime": "2017-04-12 01:38:21"字段說明list詳細(xì)狀態(tài)報(bào)告列表flag0-手機(jī)用戶上行1=狀態(tài)報(bào)告midflag=l時，消息ID與提交時響應(yīng)的消息ID匹配；flag=0時，表示該條上行的消息IDspid歸屬賬號(可忽略)mobileWL號碼acccssCodc

5、接收號碼,即SP服務(wù)號(I06XXXXXX )content手機(jī)上行的具體內(nèi)容；flag=l時，該字段無效stat狀態(tài)報(bào)告代碼，具體參見STAT狀態(tài)代碼表；flag=O時，該字段無效time手機(jī)上行的具體時間6.3 .客戶端響應(yīng)客戶端接收成功，響應(yīng)文本OK即可OK7. STATUS錯誤代碼表錯誤代碼具體含義1消息包格式錯誤2IP鑒權(quán)錯誤3賬號密碼不正確4版本號錯誤5其它錯誤6接入點(diǎn)錯誤（如賬戶本身開的是CMPP接入）7賬號狀態(tài)異常（賬號已停用）21連接過多100系統(tǒng)內(nèi)部錯誤，一般情況下例如：提交手機(jī)號碼為電信,但是該賬號沒用可用的電 信接出點(diǎn)102單次提交的號碼數(shù)過多（建議200以內(nèi)）8. R

6、ESULT錯誤代碼表錯誤代碼具體含義10原發(fā)號碼錯誤，即extno錯誤15余額不足17賬號簽名無效9. STAT狀態(tài)代碼表荷吳代碼說明DELIVRD短信投EXPIREDMessage validity period has expiredDELETEDMessage has been deleted.REJECTEDMessage is in a rejected stateMA:0001全局黑名單號碼MA:0002內(nèi)容非法MA:0003無法找到下級路由MA:0004枷MA:0005目的號碼格式錯誤MA:0006系統(tǒng)拒絕MA:0009未定義錯誤MA:001l未知系統(tǒng)內(nèi)部錯誤MA:00l2防釣魚

7、MA:00l3非法錯誤的包時序MA:00l4非法的OP ISDN號段MA:0021號碼格式蹴MA:0022號碼超過半小時下發(fā)次數(shù)限制MA:0023客戶黑名單號碼MA:0024內(nèi)容未報(bào)備MA:0025不支持該短信MA:0026分條發(fā)送，組包超時MA:0027通道黑名單MA:0028全局黑名單號段MA:0029通道黑名單號段MA:0030直接產(chǎn)生拒絕報(bào)告M0:200不支持分條短信MO:0254轉(zhuǎn)發(fā)提交超時MO:0255轉(zhuǎn)發(fā)提交過程中,連接斷開MO:NNNNNNNN為對外提交過程中，上級網(wǎng)關(guān)的返回值,具體含義需上級網(wǎng)關(guān)解釋10.常見錯誤錯誤碼10提交短信過程中返回10 ,接入碼錯誤，即ex（no=1

8、06XXXXXX不正確,解決方法：填寫正確的接入碼（網(wǎng)關(guān)管理員可以從生產(chǎn)賬號摘要中獲取該接入號）錯誤碼17提交短信過程中返回17 ,簽名錯誤解決方法:提交內(nèi)容中帶上網(wǎng)關(guān)管理員已經(jīng)報(bào)備的簽名網(wǎng)關(guān)管理員在（客戶管理一賬號簽名報(bào)備）中關(guān)閉該賬號的簽名校驗(yàn)功能錯誤碼15提交短信過程中返回15余額不足 解決方法： 網(wǎng)關(guān)管理員對該賬號充值網(wǎng)關(guān)管理員將該賬號設(shè)置為后付費(fèi)H.接入示例PHP端示例<?php namespace appcomponents;use Yii;/*，短信平臺/ class SMS Verifier extends YiibaseObject=":7862/sms/?”

9、;='999063'='Zmed8X'private static Sbaseurl private static Suscmamcprivate static Spwdprivate static Sextnoprivate static SverifyTemplate = *【哲合科技】短信驗(yàn)證碼為：%verifyCode% , %duration%分鐘內(nèi)有 效,請勿將驗(yàn)證碼提供給他人。'；private static function getCodeCacheKey(Smobile)return 'sms_' . Smobile;p

10、ublic static function gctVcrifyCode($mohilc)return Yii:$app->cache->get(self:getCodeCacheKey(Smobile);public static function sendRcgVcrifyCodc(Smobilc)ScachcCodc = Yii:$app->cachc->gct(sclf:gctCodcCachcKcy($niobilc);if (ScacheCode = false) ScacheCode = (new Comtnon()->getCode(6);Sdura

11、tion = 10; / 10 分鐘Scontcnt = str_rcplace('%verifyCode%', duration%', ScachcCodc, Sduration, self:$vcrifyTem plate);Sres 一 self:send($mobile, Scontent);if (Sres) (Yii:$app->cache->set(self:getCodeCacheKey($mobile), ScacheCode, Sduration * 60);return ScacheCode; else return false;* m

12、obile:手機(jī)號，可以是單個手機(jī)號，也可以是手機(jī)號數(shù)組* content:發(fā)送內(nèi)容，UTF-8編碼/public static function send(Smobile, Scontent)if (is array(Smobile) Smobilc = implode。,'，Smobilc);Sargv ='action' => 'send*,'account' => self:$username,'password* => self:$pwd,'mobile' => Smobile,'

13、content* => Scontcnt,'extno' => self:$extno,K => 'json',；Sflag = 0;Sparams =fbreach ($argv as Skey => Svalue) if (Sflag != 0) Sparams =Sparams .= Skey . urlencode($value);Sflag = 1;Suri = self:Sbaseurl . Sparams;Scon = (new Conunon()->curl($url, ,'post');if (Sc

14、on) (Srcsult = json dccodc($con, true);if ($result'status' = '0') return true;return false; else return false;11.1. Java端示例public static RepResult sendSms(String url, String account, String password. String mobile, String extno. String content) Map<String. String> params = new

15、HashMap<String, String>();("action", “send”);("account", account);("password'*, password);("mobile", mobile);("content","【哲合科技】"+ content); ("extno", extno);Crt", "json");String result = (url, params);RcpRcsult

16、 rcpResult = null;try rcpResult = Objcct(rcsult,); catch (Exception e) e.printStackTracc();return rcpResult;文檔目錄哲合短信接口說明文檔.錯誤!未定義書簽。1. 短信發(fā)送接錯誤!未定義書簽。1.1. 請求地址錯誤!未定義書簽。1.2. 參數(shù)說明錯誤!未定義書簽。1.3. 響應(yīng)數(shù)據(jù)錯誤!未定義書簽。2. 點(diǎn)對點(diǎn)發(fā)送.錯誤!未定義書簽。2.1. 接口請求地址錯誤!未定義書簽。2.2. 參數(shù)定義錯誤!未定義書簽。2.3. 響應(yīng)數(shù)據(jù)錯誤!未定義書簽。3. 余額查詢接口.錯誤!未定義書簽。3.1.

17、 請求地址錯誤!未定義書簽。3.2. 參數(shù)說明錯誤!未定義書簽。3.3. 響應(yīng)數(shù)據(jù)錯誤!未定義書簽。4客戶端主動獲取狀態(tài)報(bào)告接口.錯誤!未定義書簽。4.1. 請求錯誤!未定義書簽。4.2. 參數(shù)說明錯誤!未定義書簽。4.2.1. 響應(yīng)數(shù)據(jù)錯誤!未定義書簽。5. 客戶端主動獲取手機(jī)上行接口.錯誤!未定義書簽。5.1. 請求地址愆吳!未定義書簽。5.2. 參數(shù)說明錯誤!未定義書簽。5.3. 響應(yīng)數(shù)據(jù)錯誤!未定義書簽。6. 客戶端被動接收上行和狀態(tài)報(bào)告.錯誤!未定義書簽。6.1. 請求tfttlt錯誤!未定義書簽。6.2. 請求參數(shù)錯誤!未定義書簽。6.3. 客戶端響應(yīng)錯誤!未定義書簽。7. STA

18、TUS錯誤代碼表.錯誤!未定義書簽。8. RESULT瞧代碼表錯誤!未定義書簽。9.STAT狀態(tài)代碼表錯誤!未定義書簽。10. 常見能.錯誤!未定義書簽。H.接入示例.錯誤!未定義書簽。11.1. PHP端示例錯誤!未定義書簽。H.2. Java端示例錯誤!未定義書簽。1. 短信發(fā)送接口用戶客戶端向網(wǎng)關(guān)提交短信1.1 .請求地址him：ho$l：DOru'sms請求方式可以POST和GET方式,建議采用POST方式12參數(shù)說明參數(shù)需要URLENCODE ,編碼方式采用UTF-8例如：參數(shù)名稱含義說明action請求動作設(shè)置為固定的:sendaccount發(fā)送用戶帳號用戶帳號，由系統(tǒng)管理

19、員password發(fā)送帳號密碼用戶賬號對應(yīng)的密碼mobile全部被叫號碼發(fā)信發(fā)送的目的號碼.多個號碼之間用半角逗號隔開、 最多500個號碼content發(fā)送內(nèi)容短信的內(nèi)容，內(nèi)容需要UTF-8 URLEncode編碼extno接入號接入號，即SP服務(wù)號(106XXXXXX )Ft響應(yīng)數(shù)據(jù)類型jsonlittp:.7host:port,，sms?action=send&account=j!K''&password=55&mobile=,&content=內(nèi)容&extno=&rt=json13響應(yīng)數(shù)據(jù)"status"

20、: "0","balance":"list”:"mid”: "4C2CA","mobile”:也"result": 0"mid": "4C2CA'"mobile":"result": 0字段說明status請求結(jié)果，具體參見STATUS錯誤代碼表balance當(dāng)前賬戶余額，單位厘list短信提交響應(yīng)列表mid消息10(用于狀態(tài)報(bào)告匹配)mobile手機(jī)號碼result短信提交錯誤代碼，參見RESULT錯誤代碼

21、表2. 點(diǎn)對點(diǎn)發(fā)送用于客戶端向網(wǎng)關(guān)提交點(diǎn)對點(diǎn)短信，即一個號碼一個內(nèi)容的短信2.1 .接口請求地址httD：/host：Dort/sms請求方式可以POST和GET方式，建議采用POST方式22參數(shù)定義參數(shù)需要URLENCODE ,編碼方式采用UTF-8例如：參數(shù)名稱含義說明action請求動作設(shè)置為固定的:p2paccount發(fā)送用戶帳號用戶帳號，由系統(tǒng)管理員password發(fā)送帳號密碼用戶賬號對應(yīng)的密碼mobilcContcntList號碼短信內(nèi)容列表號碼內(nèi)容格式為：MobileTABContent 多個號碼之間用換行分割如：#下發(fā)內(nèi)容1#下發(fā)內(nèi)容2#下發(fā)內(nèi)容3#下發(fā)內(nèi)容4extno接入號接

22、入號，即SP服務(wù)號(106XXXXXX )rt響應(yīng)數(shù)據(jù)類型json:7822/sms?action=p2p&n=json&account=922011&password=123456&mobilcContcntList=%23%c4%b8%8b%c 5%8f%91 %e5%86%85%e5%ae%b91 %0d%23%e4%b8%8b%e5%8f%91 %e5%86%85%e5%ae%b92%0d%23%e 4%b8%8b%e5%8f%91 %e5%86%85%e5%ae%b93%0d%23%e4%b8%8b%e5%8f%91 %e5%86%85%e5%ae%b

23、9 4%0d&extno=2.3 .響應(yīng)數(shù)據(jù)"status'*: "0”，"balance":"list”："mid": "4C372C","mobile*':"result": 0,"mid”: "4C372C”,"mobile": ","result": 0"mid”: "4C372C","mobile": ,n, "r

24、esult": 0,"mid”: "4C372CA","mobile”: ", "result": 0余額查詢接口字段說明status請求結(jié)果，具體參見STATUS錯誤代碼表balance當(dāng)前賬戶余額，單位厘list短信提交響應(yīng)列表mid消息ID（用于狀態(tài)報(bào)告匹配）mobile手機(jī)號碼result短信提交錯誤代碼，參見RESULT錯誤代碼表用于客戶端查詢當(dāng)前賬戶余額3.1 .請求地址htm：/host：nort/snis請求方式可以POST和GET方式，建議采用POST方式32參數(shù)說明參數(shù)需要URLENCODE ,

25、編碼方式采用UTF-8參數(shù)名稱含義說明action請求動作設(shè)置為固定的：balanceaccount用戶帳號用戶帳號，由系統(tǒng)管理員password帳號密碼用戶賬號對應(yīng)的密碼rt響應(yīng)數(shù)據(jù)類型json例如：3.3 .響應(yīng)數(shù)據(jù)("status":0,"balance":-,"chargeType":"POSTCHARGEn字段說明status請求結(jié)果，具體參見STATUS錯誤代碼表balance當(dāng)前賬戶余額，單位厘chargeTypePOSTCHARGE=Jg付費(fèi) PRECHARGE"預(yù)付費(fèi)4 .客戶端主動獲取狀態(tài)報(bào)告接

26、口用于客戶端到網(wǎng)關(guān)獲取短信發(fā)送的狀態(tài)報(bào)告4.1 .請求地址http:/host:port,，sms請求方式可以采用POST和GET方式，建議采用POST方式42參數(shù)說明參數(shù)需要URLENCODE ,編碼方式采用UTF-8例如：參數(shù)名稱含義說明action請求動作設(shè)置為固定的：reportaccount用戶帳號用戶帳號，由系統(tǒng)管理員password帳號密碼用戶賬號對應(yīng)的密碼rt響應(yīng)數(shù)據(jù)類型jsonhttD：,，''/host：Dort/sms?action=reDort&action=report&account=W&Dassword=密碼&rt=ison421 .響應(yīng)數(shù)據(jù)"status": "0","balance":"list":Fag": 1,"mid": "4C05","spid&quo