短信網(wǎng)關(guān)SP端應(yīng)用程序接口使用詳細(xì)說明11完美版

1、短信網(wǎng)關(guān)SP端應(yīng)用程序接口使用說明SXIT_ISMG_CMPP_API使用說明本接口遵循 CMPPV2.0協(xié)議標(biāo)準(zhǔn)，以提供消息發(fā)送和接收函數(shù)的方式，向SP提供同移動網(wǎng)關(guān)進(jìn)行信息交換的實現(xiàn)途徑客戶可以依據(jù)具體需要，利用所提供的函數(shù)實現(xiàn)不同的連接方式(長連接和短連接)以及何時自動建立和中斷連接，除此之外， API作為應(yīng)用的接口，對 CMPP描述的其它功能，象流量控制、重發(fā)機(jī)制和并發(fā)處理都不預(yù)干預(yù)，需要應(yīng)用程序處理。函數(shù)說明：1、與網(wǎng)關(guān)建立連接(CMPP_Connect)函數(shù)功能與網(wǎng)關(guān)建立網(wǎng)絡(luò)連接，返回值 >0時，標(biāo)識一個連接，在以下的函數(shù)中使用 返回值>0連接成功<0連接失敗參數(shù)

2、名數(shù)據(jù)長度數(shù)據(jù)類型說明gwp20字符串網(wǎng)關(guān)的IP地址port4短整型端口號，一般為 7890user name6字符串SP的名稱passwd20字符串密碼參數(shù)說明：注意：user name是接入局分配的接入用戶名，而不是企業(yè)代碼。2、向網(wǎng)關(guān)提交信息(CMPP_Submit)函數(shù)功能向網(wǎng)關(guān)提交短信返回值=0標(biāo)識成功<0標(biāo)識發(fā)送失敗參數(shù)說明：參數(shù)名數(shù)據(jù)長度數(shù)據(jù)類型說明conn id4整型CMPP Co nn ect 返回的連接標(biāo)識p msgd8無符號整型消息ID,由網(wǎng)關(guān)返回msg_level1無符號整型消息級別serviced10字符串業(yè)務(wù)代碼msg_format1無符號整型消息格式0: A

3、SCII串 3:短信寫卡操作4 :二進(jìn)制信息8: UCS2編碼15 :含 GB 漢字。msg src6字符串消息來源(SP ld)fee_type2字符串計費(fèi)類型01 :對“計費(fèi)用戶號碼”免費(fèi)02 :對“計費(fèi)用戶號碼”按條計信息費(fèi)03 :對“計費(fèi)用戶號碼”按包月收取信息費(fèi)04 :對“計費(fèi)用戶號碼”的信息費(fèi)封頂05 :對“計費(fèi)用戶號碼”的收費(fèi)是由SP實現(xiàn)fee code6字符串資費(fèi)代碼，以分為單位valid time14字符串存活時間，格式為 YYYYMMDDHHMISSat time14字符串發(fā)送時間，格式為 YYYYMMDDHHMISStp pid1無符號整型參見GSM03.40, 一般為0

4、udhi1無符號整型參見GSM03.40, 一般為0fee_user_type1無符號整型計費(fèi)用戶類型0=對目的手機(jī)收費(fèi)， 仁對源手機(jī)收費(fèi)，2=對SP收費(fèi)，3=對charge num收費(fèi)charge mobile21字符串收費(fèi)手機(jī)號，沒有寫“ 0”src mobile21字符串源手機(jī)號，沒有寫“ 0 “user num1無符號整型接收手機(jī)個數(shù) <100dest mobiles21字符串接收手機(jī)號碼，以空格分隔msg160字符串消息內(nèi)容msg len4整型消息長度n eed_resp onse1無符號整型是否需要狀態(tài)報告0：不需要1 需<2:生成包月話單、八.,、注意：如果建立好連接

5、后一段時間沒有發(fā)送消息，網(wǎng)關(guān)將關(guān)閉連接，CMPP_Submit返回ERROR_SOCKET_CLOSE ，這時，必須重新建立連接并發(fā)送消息 3、查詢網(wǎng)關(guān)(CMPP_Query )函數(shù)功能向網(wǎng)關(guān)提交查詢包，并得到查詢結(jié)果。返回值=0 標(biāo)識成功參數(shù)名數(shù)據(jù)長度數(shù)據(jù)類型說明conn id4整型連接標(biāo)識date8字符串日期，格式為yyyymmddtype1無符號整型查詢類型0=查詢總數(shù)，1=按業(yè)務(wù)代碼查詢service10字符串查詢代碼當(dāng)Query_Type為0時，此項無效；當(dāng)Query_Type為1時，此項填與業(yè)務(wù)類型Serviced.P resX結(jié)構(gòu)體返回的結(jié)構(gòu)體<0 標(biāo)識失敗名，而不是企業(yè)代

6、碼。參數(shù)說明： 注意 :user name是接 入局分 配的接 入用戶4、主動與網(wǎng)關(guān)斷開連接函數(shù)功能主動和網(wǎng)關(guān)斷開鏈接 返回值=0 標(biāo)識成功<0 標(biāo)識失敗參數(shù)名數(shù)據(jù)長度數(shù)據(jù)類型說明conn id4整型連接標(biāo)識明：5、 連接 M0 網(wǎng)關(guān)(CMPP_Connect_MO )函數(shù)功能連接MO虛擬鏈路到網(wǎng)關(guān)返回值>0標(biāo)識成功 返回值標(biāo)識一個連接，在以下的函數(shù)中使用 <0 標(biāo)識失敗參數(shù)說明：參數(shù)名數(shù)據(jù)長度數(shù)據(jù)類型說明gwp20字符串網(wǎng)關(guān)的IP地址port4短整型端口號，一般為 7910user name6字符串SP的名稱passwd20字符串密碼user name是接入局 分配的接 入

7、用戶數(shù) 說明： 注意：名，而不是企業(yè)代碼。6、等待并接收 M0消息函數(shù)功能連接MO虛擬鏈路到網(wǎng)關(guān)返回值=0標(biāo)識成功 返回值標(biāo)識一個連接，在以下的函數(shù)中使用 <0 標(biāo)識失敗參數(shù)名數(shù)據(jù)長度數(shù)據(jù)類型說明Con n id4整型連接標(biāo)識p MOX結(jié)構(gòu)體返回的MO消息參數(shù)說明：注意：如果沒有MO消息將阻塞，直至 MO消息到達(dá)或連接被網(wǎng)關(guān)關(guān)閉7、刪除短信(CMPP_Cancel)函數(shù)功能向網(wǎng)關(guān)提交查詢包，并得到查詢結(jié)果。 返回值=0 標(biāo)識成功<0 標(biāo)識失敗參數(shù)名數(shù)據(jù)長度數(shù)據(jù)類型說明conn id4整型連接標(biāo)識msgd8無符號整型消息ID,由網(wǎng)關(guān)返回p_Ca ncel_Rep MsgX結(jié)構(gòu)體返回的

8、刪除短信響應(yīng)結(jié)果參數(shù)說明：8 短連接(以短連接的方式向網(wǎng)關(guān)提交消息，直接調(diào)用即可)函數(shù)功能向網(wǎng)關(guān)提交短信返回值=0 一次連接發(fā)送成功<0連接或發(fā)送失敗參數(shù)說明：參數(shù)名數(shù)據(jù)長度數(shù)據(jù)類型說明gw_ip20字符串網(wǎng)關(guān)的IP地址port4短整型端口號，一般為 7900user name6字符串SP的名稱passwd20字符串密碼p_msgd8無符號整型消息ID,由網(wǎng)關(guān)返回msg_level1無符號整型消息級別serviced10字符串業(yè)務(wù)代碼msg_format1無符號整型消息格式0: ASCII串 3:短信寫卡操作4 :二進(jìn)制信息8: UCS2編碼15 :含 GB 漢字。msg_src6字符串

9、消息來源(SP ld)fee_type2字符串計費(fèi)類型01 :對“計費(fèi)用戶號碼”免費(fèi)02 :對“計費(fèi)用戶號碼”按條計信息費(fèi)03 :對“計費(fèi)用戶號碼”按包月收取信息費(fèi)04 :對“計費(fèi)用戶號碼”的信息費(fèi)封頂05 :對“計費(fèi)用戶號碼”的收費(fèi)是由SP實現(xiàn)fee code6字符串資費(fèi)代碼，以分為單位valid time14字符串存活時間，格式為 YYYYMMDDHHMISSat time14字符串發(fā)送時間，格式為 YYYYMMDDHHMISStp pid1無符號整型參見GSM03.40, 一般為0udhi1無符號整型參見GSM03.40, 一般為0fee_user_type1無符號整型計費(fèi)用戶類型0=對

10、目的手機(jī)收費(fèi)， 仁對源手機(jī)收費(fèi)，2=對SP收費(fèi)，3=對charge num收費(fèi)charge mobile21字符串收費(fèi)手機(jī)號，沒有寫“ 0”src mobile21字符串源手機(jī)號，沒有寫“ 0 “user num1無符號整型接收手機(jī)個數(shù) <100dest mobiles21字符串接收手機(jī)號碼，以空格分隔msg160字符串消息內(nèi)容msg len4整型消息長度n eed_resp onse1無符號整型是否需要狀態(tài)報告0：不需要1 需<2:取消包月9、檢查 MO消息是否是狀態(tài)報告(is_status_report)函數(shù)功能判斷MO包是否為狀態(tài)報告 返回值=0 普通MO消息=1 狀態(tài)報告參

11、數(shù)說明：10、從 MO消息得到狀態(tài)報告(get_status_report)函數(shù)功能從MO包中得到狀態(tài)報告返回值狀態(tài)報告指針參數(shù)名數(shù)據(jù)長度1數(shù)據(jù)類型說明p MOX結(jié)構(gòu)體CMPP Get MO得到的結(jié)構(gòu)體參數(shù)說明11、鏈路檢測(CMPP_Active )函數(shù)功能保持鏈路鏈接正常返回值<0 :錯誤=0 :正常參數(shù)名數(shù)據(jù)長度1數(shù)據(jù)類型說明Con n id4整型連接標(biāo)識參數(shù)說明結(jié)構(gòu)體說明參數(shù)名數(shù)據(jù)長度數(shù)據(jù)類型說明mt total msg4無符號整型從SP接收的用戶總數(shù)mt total user4無符號整型從SP接收的信息總數(shù)mt succ4無符號整型成功轉(zhuǎn)發(fā)數(shù)量mt wait4無符號整型待轉(zhuǎn)發(fā)數(shù)

12、量mt fail4無符號整型轉(zhuǎn)發(fā)失敗數(shù)量mo succ4無符號整型向SP成功送達(dá)數(shù)量mo wait4無符號整型向SP待送達(dá)數(shù)量mo fail4無符號整型向SP送達(dá)失敗數(shù)量1、查詢結(jié)果結(jié)構(gòu)體(Query_Res):2、MO消息參數(shù)名數(shù)據(jù)長度數(shù)據(jù)類型說明msgID8整型消息IDdest id21字符串接入號碼serviced10字符串業(yè)務(wù)代碼tp pid1無符號整型見GSM03.40 ,通常為0tp_udhi1無符號整型見GSM03.40 ,通常為0msgFormat1無符號整型r消息格式sourceUser21字符串:發(fā)送消息的手機(jī)reg deliver1無符號整型是否為應(yīng)答消息，仁yes, 0

13、=nomsgLe n1無符號整型:消息長度msg160字符串消息內(nèi)容3、狀態(tài)報告參數(shù)名數(shù)據(jù)長度數(shù)據(jù)類型說明msgID8整型消息ID,與CMPP_Submit中返回的消息ID對應(yīng)stat7字符串狀態(tài)submit time10字符串提交時間，MMDDHHMMSSdon e time10字符串完成時間，MMDDHHMMSSdestUser21字符串接收手機(jī)smsc seq4無符號整型短信中心序列號四、常量說明1狀態(tài)報告中的狀態(tài)：常量名說明DELIVRD短信成功傳送EXPIRED超過短信的有效期DELETED短信被刪除UNDELIV短信無法送達(dá)ACCEPTD處于被接受狀態(tài)UNKNOWN處于非法狀態(tài)RE

14、JECTD處于被拒絕狀態(tài)DELIVRD短信成功傳送2、錯誤碼常量名代表值說明ERROR OK0正常ERROR SOCKET CREATE-100創(chuàng)建socket失敗ERROR CONNECT-101聯(lián)接到網(wǎng)關(guān)失敗ERROR SOCKET WRITE-102寫socket失敗ERROR SOCKET READ-103讀socket失敗ERROR ICP ID-104錯誤的SP IDERROR AUTH-105認(rèn)證錯誤ERROR MSG LEN-106短消息長度錯ERROR FEE CODE-107計費(fèi)代碼錯ERROR SERVICE ID-108業(yè)務(wù)代碼錯ERROR FLOW CONTROL-1

15、09流量控制錯ERROR SOCKET CLOSE-110當(dāng)對Socket操作時，socket關(guān)閉ERROR_INTERNAL-200內(nèi)部錯誤，一般為信息結(jié)構(gòu)錯ERROR UNKNOWN-201未知錯誤ERROR ARGUMENT-202調(diào)用api函數(shù)參數(shù)錯五、常見問題解答1、 為何聯(lián)接到網(wǎng)關(guān)時網(wǎng)關(guān)回復(fù)ERROR_AUTH錯誤碼？答：深訊網(wǎng)關(guān)在 SP信息里有企業(yè)代碼、SP名稱、密碼三項，網(wǎng)關(guān)要求 SP鑒權(quán)時填寫的用戶名 為局方分配的SP名稱，而不是企業(yè)代碼，密碼為局方分配的SP密碼。2、 為何聯(lián)接到網(wǎng)關(guān)時網(wǎng)關(guān)回復(fù)ERROR_SOCKET_READ 錯誤碼？答：造成此問題的原因很可能是你的IP同局方管理人員設(shè)置的IP不一致。請與局方管理人員核對數(shù)據(jù)。3、 為何向網(wǎng)關(guān)提交短信時會返回ERROR_MSG_LEN錯誤碼？答：CMPP2.0協(xié)議有規(guī)定：信息長度當(dāng) Msg_Fmt值為0時：160個字節(jié)；其它=140個字節(jié);當(dāng)你的短信消息長度超長時，網(wǎng)關(guān)會返回ERROR_MSG_L