短信網關SP端應用程序接口使用詳細說明(doc11頁)(正式版)

1、短信網關sp端應用程序接口使用說明- sxit_ismg_cmpp_api使用說明本接口遵循 cmppv2.0協(xié)議標準，以提供消息發(fā)送和接收函數的方式，向sp提供同移動網關進行信息交換的實現途徑.客戶可以依據具體需要，利用所提供的函數實現不同的連接方式(長連接和短連接)以及何時自動建立和中斷連接，除此之外， api作為應用的接口，對 cmpp描述的其它功能，象流量控制 、重發(fā)機制和并發(fā)處理都不預 干預，需要應用程序處理。函數說明：1、 與網關建立連接(cmpp_connect) 函數功能與網關建立網絡連接，返回值 0時，標識一個連接，在以下的函數中使用 返回值0連接成功0連接失敗參數名數據長度

2、數據類型說明gw_ip20字符串網關的ip地址port4短整型端口號，一般為 7890username6字符串sp的名稱passwd20字符串密碼入用戶名，而不是企業(yè)代碼。參數說明：username是接入局分配的接2、向網關提交信息(cmpp_submit) 函數功能向網關提交短信 返回值=0標識成功0標識發(fā)送失敗參數說明：參數名數據長度數據類型說明conn_id4整型cmpp_connect 返回的連接標識p_msg_id8無符號整型肖息id,由網關返回msg_level1無符號整型消息級別service_id10字符串業(yè)務代碼msg_format1無符號整型消息格式0: ascii串 3:

3、短信寫卡操作4:二進制信息8: ucs2編碼15：含 gb 漢字 oooooomsg_src6字符串口肖息來源(sp_id)fee_type2字符串計費類型01:對“計費用戶號碼”免費02 :對“計費用戶號碼”按條計信息費03:對“計費用戶號碼”按包月收取信息費04：對“計費用戶號碼”的信息費封頂05:對“計費用戶號碼”的收費是由sp實現fee_code6字符串資費代碼，以分為單位valid_time14字符串f存活時間，格式為 yyyymmddhhmissat_time14字符串發(fā)送時間，格式為 yyyymmddhhmisstp_pid1無符號整型參見gsm03.40, 一般為0udhi1無

4、符號整型參見gsm03.40, 一般為0fee_user_type1無符號整型計費用戶類型0=對目的手機收費，1=對源手機收費，2=對sp收費，3=對charge_num收費charge_mobile21字符串收費手機號，沒有寫“ 0”src_mobile21字符串源手機號，沒有寫“ 0 ”user_num1無符號整型接收手機個數 100dest_mobiles21字符串接收手機號碼，以空格分隔msg160字符串消息內容msg len4整型消息長度need_response1無符號整型是否需要狀態(tài)報告0：不需要1：需要2:生成包月話單汪思：如果建立好連接后一段時間沒有發(fā)送消息，網關將關閉連接，

5、cmpp_submit返回error_socket_close ,這時，必須重新建立連接并發(fā)送消息3、查詢網關(cmpp_query)函數功能向網關提交查詢包，并得到查詢結果。返回值=0 標識成功0標識失敗參參數名數據長度數據類型說明數conn_id4整型連接標識說date8字符串日期，格式為 yyyymmdd明：type1無符號整型查詢類型0=查詢總數，1=按業(yè)務代碼查詢 注service10字符串查詢代碼當query_type為0時，此項無效；當query_type為1時，此項填與業(yè)務典型 service_id.息：usernam e是接 入局分p_resx結構體返回的結構體配的接名，而/

6、、是企業(yè)代碼。4、主動與網關斷開連接函數功能主動和網關斷開鏈接返回值=0 標識成功0標識成功0 標識失敗參數說明：返回值標識一個連接，在以下的函數中使用參數參數名數據長度數據類型說明說明：gw_ip20字符串網關的ip地址 一、/ t土后：port4短整型端口號，一般為 7910usernameusername6字符串sp的名稱是接入局passwd20字符串密碼分配的接名，而/、是企業(yè)代碼。6、等待并接收 mo消息函數功能連接mo虛擬鏈路到網關返回值=0標識成功 返回值標識一個連接，在以下的函數中使用0 標識失敗入用戶參數名數據長度數據類型說明conn_id4整型連接標識p_mox結構體返回的

7、mo消息參數說明： 一、/注思：7、如果沒有mo消息將阻塞，直至 mo消息到達或連接被網關關閉刪除短信(cmpp_cancel)函數功能向網關提交查詢包，并得到查詢結果。返回值=0 標識成功0 標識失敗參數名數據度數據類型說明conn_id4整型r連接標識msg_id8無符號整型消息id,由網關返回p_cancel_ rep_msgx結構體返回的刪除短信響應結果參數說明：8、短連接(以短連接的方式向網關提交消息，直接調用即可) 函數功能向網關提交短信返回值=0 一次連接發(fā)送成功0連接或發(fā)送失敗參數說明：參數名數據長度數據類型說明gw_ip20字符串網關的ip地址port4短整型端口號，一般為

8、7900username6字符串sp的名稱passwd20字符串密碼p_msg_id8無符號整型消息id,由網關返回msg_level1無符號整型消息級別service_id10字符串業(yè)務代碼msg_format1無符號整型消息格式0: ascii串 3:短信寫卡操作4:二進制信息8: ucs2編碼15：含 gb 漢字 oooooomsg_src6字符串消息來源(sp_id)fee_type2字符串計費類型01:對“計費用戶號碼”免費02 :對“計費用戶號碼”按條計信息費03:對“計費用戶號碼”按包月收取信息費04：對“計費用戶號碼”的信息費封頂05:對“計費用戶號碼”的收費是由sp實現fee

9、_code6字符串資費代碼，以分為單位valid_time14字符串存活時間，格式為 yyyymmddhhmissat_time14字符串發(fā)送時間，格式為 yyyymmddhhmisstp_pid1無符號整型參見gsm03.40, 一般為0udhi1無符號整型參見gsm03.40, 一般為0fee_user_type1無符號整型計費用戶類型0=對目的手機收費，1=對源手機收費，2=對sp收費，3=對charge_num收費charge_mobile21字符串收費手機號，沒有寫“ 0”src_mobile21字符串源手機號，沒有寫“ 0 ”user_num1無符號整型接收手機個數 100dest

10、_mobiles21字符串接收手機號碼，以空格分隔msg160字符串消息內容msg len4整型消息長度need_response1無符號整型是否需要狀態(tài)報告0：不需要1：需要2:取消包月9、檢查 mo消息是否是狀態(tài)報告(is_status_report)函數功能判斷mo包是否為狀態(tài)報告返回值=0 普通mo消息=1 狀態(tài)報告 參數說明：10、從mo消息得到狀態(tài)報告(get_status_report) 函數功能從mo包中得到狀態(tài)報告 返回值狀態(tài)報告指針參數名數據度1數據類型說明p_mox結構體cmpp_get_mo得到的結構體參數說明11、鏈路檢測(cmpp_active )函數功能保持鏈路鏈

11、接正常 返回值0:錯誤=0:正常參數名數據度1數據類型說明conn_id4整型連接標識參數說明結構體說明參數名數據長度數據類型說明mt_total_msg4無符號整型從sp接收的用戶總數mt_total_user4無符號整型從sp接收的信息總數mt_succ4無符號整型成功轉發(fā)數量mt_wait4無符號整型待轉發(fā)數量mt_fail4無符號整型轉發(fā)失敗數量mo_succ4無符號整型向sp成功送達數量mo_wait4無符號整型向sp待送達數量mo_fail4無符號整型向sp送達失敗數量1、查詢結果結構體(query_res):2、mo消息參數名數據長度數據類型說明msgid8整型消息iddest_

12、id21字符串接入號碼service_id10字符串業(yè)務代碼tp_pid1無符號整型見gsm03.40 ,通常為0tp_udhi1無符號整型見gsm03.40 ,通常為0msgformat1無符號整型r消息格式sourceuser21字符串發(fā)送消息的手機reg_deliver1無符號整型是否為應答消息，1=yes, 0=nomsglen1無符號整型;消息長度msg160字符串消息內容3、狀態(tài)報告參數名數據長度數據類型說明msgid8整型消息id ,與cmpp_submit中返回的消息id對應stat7字符串狀態(tài)submit_time10字符串提交時間，mmddhhmmssdone_time10

13、字符串完成時間，mmddhhmmssdestuser21字符串接收手機smsc_seq4無符號整型短信中心序列號四、常量說明1、狀態(tài)報告中的狀態(tài):常量名說明delivrd短信成功傳送expired超過短信的有效期deleted短信被刪除undeliv短信無法送達acceptd處于被接受狀態(tài)unknown處于非法狀態(tài)rejectd處于被拒絕狀態(tài)delivrd短信成功傳送2、錯誤碼常量名代表值說明error_ok0正常error_socket_create-100創(chuàng)建socket失敗error_connect-101聯接到網關失敗error_socket_write-102寫socket失敗err

14、or_socket_read-103讀socket失敗error_icp_id-104錯誤的sp_iderror_auth-105認證錯誤error_msg_len-106短消息長度錯error_fee_code-107計費代碼錯error_service_id-108業(yè)務代碼錯error_flow_control-109流量控制錯error_socket_close-110當對socket操作日socket關閉error_internal-200內部錯誤，一般為信息結構錯error_unknown-201未知錯誤error_argument-202調用api函數參數錯五、常見問題解答1、為何

15、聯接到網關時網關回復error_auth錯誤碼？答：深訊網關在 sp信息里有企業(yè)代碼、sp名稱、密碼三項，網關要求 sp鑒權時填寫的用戶名 為局方分配的sp名稱，而不是企業(yè)代碼，密碼為局方分配的sp密碼。2、為何聯接到網關時網關回復error_socket_read 錯誤碼？答：造成此問題的原因很可能是你的ip同局方管理人員設置的ip不一致。請與局方管理人員核對數據。3、為何向網關提交短信時會返回error_msg_len錯誤碼？答：cmpp2.0協(xié)議有規(guī)定：信息長度當 msg_fmt值為0時：160個字節(jié)；其它=140個字節(jié);當你的短信消息長度超長時，網關會返回error_msg_len錯誤碼。4