1、大漢三通三通運營平臺接口手冊CHINA TRICOM產品名稱三通運營平臺版本編號1213.57570文檔編號1.0.2發布者上海大漢三通網絡通信有限公司發布日期最后修改日期2011/11/9目錄1、 引言 51.1. 目的 51.2. 名稱解釋 52、 短信 52.1. API 接口 52.2. WebService 接口 102.2.1. 自定義數據結構 112.2.2. 短信下行（發送一條或者多條內容相同的短信） 112.2.3. 短信下行（發送內容不同的短信） 122.2.4. 獲取上行 132.2.5. 獲取狀態報告 142.2.6. 獲取余額 152.2.7. 短信 webservi

2、ce 錯誤碼 162.3.WebService 接口（ xml 方式傳輸數據） 162.3.1. 短信下行 162.3.2. 短信上行 182.3.3. 短信狀態報告 192.3.4. 查詢余額 212.4. http 接口（ xml 方式傳輸數據） 232.4.1.短信下行 232.4.2.短信上行 242.4.3.短信狀態報告 262.4.4. 查詢余額 27保密本文件及其內容為上海大漢三通網絡通信有限公司保密資料。本文件及其內容永遠屬于上海大漢三通網絡通信有限公司擁有財產，在無上海大漢三通網絡通信有限公司采用書面形式表示同意外，本文件a. 不可以用于其他非原指定用途；b. 不可以向第三方

3、披露；c. 不可采用任何形式進行復制和傳播，包括但不限于 傳真、紙張郵件和電子郵件。文檔修改歷史版本修改人日期描述1.0.0湯喜金2011/6/1創建文檔。短信部分接口。1.0.0周艷2011/7/7文檔格式修改，符合公司內部文檔規范要求。1.0.2湯喜金2011/11/14增加xml方式傳輸數據的 WebService接口1、 引言1.1. 目的該接口手冊編寫目的在于描述三通運營平臺CTC-OSS （以下簡稱CTC-OSS）具體的接口協 議，供接口用戶進行接口的對接開發。12名稱解釋縮略語英文全名中文全名CTC-OSSOperational Support System三通運營平臺SMSSh

4、ort Messagi ng Service短消息服務MMSMultimedia Message Service多媒體消息APIApplicati on Programmi ng In terface應用程序編程接口MOMessage Original消息上行MTMessage Terminal消息下行SPService Provider服務提供商CPContent Provider內容提供商2、短信2.1. API 接口相關jar包包括：ctc-smsclient.jar，ctc-message.ja，ctc-slidewindow.jar，ctc-sync.jar， ctc-util.ja

5、r。注意：終端客戶的接入方式設置為API接入時才能使用此接口名稱in itC onn功能連接初始化。接口方法publicint in itC onn( Stri ng host,int port, Stri ng user,Stri ng password)輸入說明host: CTC-OSS 的 ip; port: CTC-OSS 的端口； user：接口用戶名； password :接口密碼。輸出說明0-成功1-已經登陸2-用戶名錯誤3-密碼錯誤4-客戶端ip錯誤（需要校驗ip的時候需要）5-其他名稱sen dSms功能發送短信。接口方法publicboolea n sen dSms(Str

6、i ngfrom, Str ingto, Stringmsg)輸入說明from :子號碼，一般不填寫；to :手機號碼，支持多號碼，以央文逗號隔開。建議一次取多100個；msg :短信內容。輸出說明true:成功；false:失敗。名稱on SubmitedSMS功能接收下行短信響應。sendSms方法不直接返回下行響應，由此方法返回，此方法為回調方法，不需要手動調用。接口方法publicboolea n on SubmitedSMS(ISubmitMsg arg0)輸入說明arg0 :下行數據結構，具體支段見示例。輸出說明true:成功；false:失敗。名稱on DeliverSMS功能接

7、收上行短信。 此方法為回調方法，不需要手動調用。接口方法publicboolea non DeliverSMS(IDeliverMsg argO)輸入說明argO :上行數據結構，具體支段見示例。輸出說明true：成功；false:失敗。名稱onM TReportSMS功能接收狀態報告。 此方法為回調方法，不需要手動調用。接口方法publicboolea n onM TReportSMS(IReportMsg arg0)輸入說明arg0 :狀態報告 數據結構，具體支段見示例。輸出說明true：成功；false:失敗。示例程序:importcom.ch in atricom.message .I

8、 DeliverMsg;importcom.ch in atricom.message .I ReportMsg;importcom.chi natricom.message .I SubmitMsg;importcom.chi natricom.slidewi ndow.SMSCallback;importcom.ch in atricom.smsclie nt.ctcpp.CtcppCha nn el;importcom.ch in atricom.smsclie nt.message.DeliverMsg;importcom.chi natricom.smsclie nt.message

9、.ReportMsg;importcom.chi natricom.smsclie nt.message.SubmitMsg;* title:調用 CTC- SMS API 客戶端接口 SMSUtil.javacreate on 2010-10-26copyright (c)* 2010-10-26* versio n 1.0*/publicclass SMSUtilimpleme ntsSMSCallback publicstaticCtcppCha nnel_chan = n ull ;s tatic/相關參數定義SMSUtil _clie nt =new SMSUtil();Stri n

10、g host =;/ 調用IP地址intport = 28013;/ 調用IP地址的端口Stri ng user =8888 ; /用戶名Stri ng passwd =8888 ; /密碼intwn dSize = 16;inttimeout = 60 *1000;/ 連接超時時間inttrys = 3;intspeed = 0;/記錄日志System. out .println(start);/開啟通道cha n* authornew CtcppCha nn el(host, port, user, passwd, 1, wn dSize,timeout,/ *cha n

11、.start();*這個函數接收上行短信，短信的各個字段都放在DeliverMsgtrys, speed, _client, 0, 0, 1, 1);*/public boolea non DeliverSMS(IDeliverMsg argO) DeliverMsg msg = (DeliverMsg) argO;if (msg !=n ull ) System. out .println(收至U deliverMsg:phone=+ msg.getFrom()+ ,內容=+ msg.getMsg() +,to=+ msg.getTo();return true ;/ *這個函數接收下發短信

12、的狀態報告，它通過msgid關聯到下行短信 result : 0成功1 等待發送2 失敗*/public boolea nonM TReportSMS(IReportMsg argO) ReportMsg msg = (ReportMsg) argO;if (msg != n ull ) System. out .println(收至U repot:result= + msg.getResult()+return true ;*這個函數接收下行短信的response , SubmitMsg 里面有了 result 和msgid,這里的msg 就是 _cha n. submit(_msg)*里面

13、的_msg。result = 0表示成功，其他均為失敗。*/publicboolea non SubmitedSMS(ISubmitMsg argO) SubmitMsg msg = (SubmitMsg) argO;if (msg !=n ull ) System. out .println(收至U submit response:result+ =+ msg.getResult() +, msgid= + msg.getMsgld();return true ;*下發方法入口*/public static void sen dSMS(Stri ng phon eNumber, String

14、 smsC on text) try SubmitMsg _msg = new SubmitMsg();_msg.setCha nId(1);_msg.setFrom( 1);_msg.setTo(ph on eNumber);_msg.setMsg(smsC on text);_chan .submit(_msg); catch (Exception e) e.pri ntStackTrace(); fin allypublic static void main( Stri ng args) SMSUtil.sendSMS test );2.2. WebServi

15、ce 接口注意：終端客戶的接入方式設置為WebService接入時才能使用此接口訪問地址：http:/3to ng. net:8090/services/Se ndSms2.2.1.自定義數據結構MtNewMessage參數名稱類型說明smsIdStri ng消息序號，用來取狀態報告時候匹配，可以為空，建議不填寫，為空時服務端會返回一個唯一的消息序號。pho neNumberStri ng手機號碼。支持多號碼，號碼之間用央文逗號隔開 ，建議取多100個。如13900000000。contentStri ng短信內容。scheduleTimeDate下行時間，可以為空。

16、WappushurlStri ngWappush地址，如果需要發送Wappush，則 Content表示title2.2.2. 短信下行（發送一條或者多條內容相同的短信）名稱sen dSms功能發送一條或則多條內容相冋的短信。接口方法sen dSms(Stri ng accou nt, Str ing password, MtNewMessage message)輸入說明accou nt用戶賬號；password用戶密碼（用 MD5加密，32位，加密后字母全部為小寫，例如：“加密后應該等于“ Cbff36039c3d0212b3e34c23dcde1456 ”可以用此例子驗證加密方法是否正確）

17、;message對象，詳情請參照自疋義數據結構：MtNewMessage。輸出說明Strin g字符串數組String0:輸出參數，小于零時表示下發錯誤，詳情見錯誤碼String1:發送情況返回（當errMsg不為負值時該值有效）格式（無換行符）：vpho ne150000000002c9281e22c1ac7c2012c1adc8bdb0021132-72.23 短信下行（發送內容不同的短信）名稱batchSe ndSms功能發送一條或則多條內容相冋的短信。接口方法batchSendSms(String account, String password, MtNewMessage messa

18、ge)輸入說明accou nt用戶賬號；password用戶密碼（用 MD5加密，32位，加密后字母全部為小寫，例如：“加密后應該等于“ cbff36039c3d0212b3e34c23dcde1456 ”可以用此例子驗證加密方法是否正確）;message對象數組，詳情請參照自疋義數據結構：MtNewMessage。輸出說明String字符串數組StringO:輸出參數，小于零時表示下發錯誤，詳情見錯誤碼Str in g1:發送情況返回（當errMsg不為負值時該值有效）格式（無換行符）：vbatchSe ndResp150007927992c9281e22c5d9f77012c5da2d0b

19、7001bv/smsvpho ne150007927992c9281e22c5d9f77012c5da2d0c0001cv/batchSe ndResp2.24 獲取上行調用短信上行間隔時間不小于30秒。名稱getSms功能獲取上行短信，一次最多取10條。接口方法getSms(Stri ng acco unt. String password)輸入說明accou nt用戶賬號；password用戶密碼（用 MD5加密，32位，加密后字母全部為小寫，例如：“加密后應該等于“ Cbff36039c3d0212b3e34c23dcde1456 ”可以用此例子驗證加密方法是否正確）。輸出說明Strin

20、g字符串數組String0:輸出參數，小于零時表示下發錯誤，詳情見錯誤碼String1:返回上行短信（當 errMsg不為負值時該值有效） 格式（無換行符）：vpho nest MO!測試 Deliver 消息est MO!測試 Deliver 消息!沒有上行時返回：v/mosms225.獲取狀態報告調用短信狀態報告間隔時間不小于30秒。名稱getReport功能獲取一條或者多條狀態報告。接口方法getReport(Stri ngacco unt. String password,MtNewMessagemessage)輸入說明accou n

21、t用戶賬號；password用戶密碼（用 MD5加密，32位，加密后字母全部為小寫，例如：“加密后應該等于“ cbff36039c3d0212b3e34c23dcde1456 ”可以用此例子驗證加密方法是否正確）；MtNewMessage，詳情請參照自疋義數據結構：MtNewMessage,包含消息序號和手機號碼的對象數組。（只需要填寫smsId和phon eNumber 字段）。輸出說明String字符串數組StringO:輸出參數，小于零時表示下發錯誤，詳情見錯誤碼String1:返回狀態報告（當 errMsg不為負值時該值有效）格式（無換行符）：138877878782c9281e22b

22、f60182012bf6025949001aO138877878792c9dd1e22aa6018dd12bf60ff59490550無狀態報告時返回：2.26 獲取余額調用獲取余額報告間隔時間不小于30秒。名稱getBala nee功能獲取帳號余額。接口方法getBala nce(Stri ng acco unt. String password)輸入說明account用戶賬號；password用戶密碼（用 MD5加密，32位，加密后字母全部為小寫，例如：“加密后應該等于“ cbff36039c3d0212b3e34c23dcde1456 ”可以用此例子驗證加密方法是否正確）。輸出說明Str

23、ing字符串數組String0:輸出參數，小于零時表示下發錯誤，詳情見錯誤碼String1:返回賬戶余額（當 errMsg不為負值時該值有效） 格式（無換行符）：0432162.2.7. 短信 webservice 錯誤碼-1：輸入參數不正確，請檢查賬戶，密碼，等輸入參數是否為空-2 :賬戶不存在，請檢查用戶名密碼是否正確-3 :賬戶已經超過每日發送短信限制數量（當賬戶被限制每日發送量時有用）-4:客戶端ip地址不正確（當需要ip校驗時）-5: smsld與數據庫重復（下發短信時，如果smsld由客戶端傳入，該參數不能重復）-6:內容含有非法關鍵字，請檢查下發內容。-7:對應的號碼下發失敗，下

24、發號碼為空或其他錯誤，導致該號碼發送失敗-8:賬戶余額不足2.3. WebService接口（ xml方式傳輸數據）注意：終端客戶的接入方式設置為WebService接入時才能使用此接口。該接口數據輸入輸出均采用xml格式封裝的字符串，編碼統一為UTF-8。訪問地址：http:/3t on g. net:8090/services/sms2.3.1.短信下行名稱submitru 匕匕 號 厶冃發送一條或則多條內容相同的短信接口 方 法String submit(Stri ng message)輸message參數xml格式如下：入說vaccou nt adm inbb43a2c4081bec0

25、2fca7b72f38e63021明2c92825934837c4d0134837dcba001501311111111113333333333短信內容 5555201101011230phones 字段說明：accou nt:用戶賬號password :賬號密碼，需米用 MD5加密（小寫），如：加密后為bb43a2c4081bec02fca7b72f38e63021msgid :該批短信編號（32位UUID），需保證唯一，可空，建議為空phones :接收手機號碼，多個手機號碼用英文逗號分隔，最多500，不能為空content:短信內容，最多 500個漢字，不能為空

26、20位）subcode :擴展子號碼，可空（驗證格式和長度，不能超過sendtime :發送時間，格式yyyyMMddHHmm,可空（12位數字，年月日時分，比如 201111180929)輸返回的結果xml格式如下：出說2c92825934837c4d0134837dcba00150明0 提交成功 字段說明：msgid :該批短信編號result:該批短信提交結果0提交成功aml/.1賬號尢效2密碼錯誤3msgid 不唯一4存在無效手機號碼5手機號碼個數超過最大限制6短信內容超過最大限制7擴展子號碼無效8發送時間格式無效9請求來源地址無效10內容包含敏感詞11余額不足97接入方式錯誤98系統

27、繁忙99消息格式錯誤2.32 短信上行名deliver稱功獲取上行短信。每次調用間隔需大于30秒匕匕 厶冃接String deliver(Stri ng message)口方法輸message參數xml格式如下：入v?xml version =1.0en cod ing =UTF-8 ?說vaccou nt adm in明bb43a2c4081bec02fca7b72f38e63021字段說明：accou nt:用戶賬號password :賬號密碼，需米用 MD5加密（小寫），如：加密后為bb43a2c4081bec02fca7b72f38e63021輸 出 說 明返回的結果xml格式如下：v

28、result 0 成功 vphonevcontent 短信內容 vsubcode 5555vdelivertime2011-11-11 11:11:11字段說明：result:接口調用結果0成功1賬號無效2密碼錯誤3請求太快9請求來源地址無效97接入方式錯誤98系統繁忙99消息格式錯誤如果result為0時sms標簽對將出現0到多次，否則sms標簽不出現。phone :上行手機號碼content :上行短信內容delivertime:上行接收時間，格式yyyy-MM-dd HH:mm:ss2.33短信狀態報告名稱report功獲取下行短信狀態報告，每次調用間隔需大于3

29、0秒。臺匕冃匕接String report(Stri ng message)口方法輸message參數xml格式如下：入說vaccou nt adm in明bb43a2c4081bec02fca7b72f38e630212c92825934837c4d0134837dcba0015013622223333字段說明：accou nt:用戶賬號password :賬號密碼，需米用 MD5加密（小寫），如：加密后為bb43a2c4081bec02fca7b72f38e63021msgid:下行短信編號，可空phone：接收下行手機號碼，可空輸返回的結果xml格式如下：出說0明 成功 2c928259

30、34837c4d0134837dcba00150136222233330成功 字段說明：result：接口調用結果0成功aml/.1賬號尢效2密碼錯誤3請求太快4手機號碼無效9請求來源地址無效97接入方式錯誤98系統繁忙99消息格式錯誤當result為0時report標簽對將出現0到多次，否則report標簽不出現msgid :短信編號phone :下行手機號碼content :上行短信內容status :短信發送結果0成功1失敗2發送中2.34 查詢余額名bala nee稱功獲取余額，每次調用間隔需大于60秒。匕匕 厶冃接String balance(String message)口方法輸m

31、essage參數xml格式如下：入v?xml version =1.0en cod ing =UTF-8 ?說adm in明bb43a2c4081bec02fca7b72f38e63021字段說明：accou nt:用戶賬號password :賬號密碼，需采用 MD5 加密，女口： 加密后為 bb43a2c4081bec02fca7b72f38e63021輸 出 說 明返回的結果xml格式如下：vresult 0 成功 100.0005000.000200.0005000.000字段說明：result：接口調用結果0成功1賬號無效2密碼錯誤3請求太快9請求來源地址無效97接入方式錯誤98系統繁

32、忙99消息格式錯誤當result為0時sms標簽對出現1次，否則sms標簽對不出現。amount:剩余金額，保留 3位小數，單位元number :剩余短信數freeze :凍結金額， 保留3位小數，單位元當result為0時mms標簽對出現1次，否則 mms標簽對不出現。amount:剩余金額，保留 3位小數，單位元number :剩余彩信數freeze:凍結金額，保留3位小數，單位元24 http接口（ xml方式傳輸數據）注意：終端客戶的接入方式設置為http接入時才能使用此接口。該接口數據輸入輸出均采用xml格式封裝的字符串，編碼統一為UTF-8。建議采用post方式提交請求2.4.1.

33、短信下行訪問地址：:8090 /http/sms/Submit名稱submit功發送一條或則多條內容相冋的短信匕匕 厶冃輸message參數xml格式如下：入說vaccou nt adm in明bb43a2c4081bec02fca7b72f38e630212c92825934837c4d0134837dcba001501311111111113333333333短信內容 5555201101011230phones 字段說明：accou nt:用戶賬號password :賬號密碼，需采用 MD5加密（小寫），如：加密后為bb43a2c4081bec02fca7b72

34、f38e63021msgid :該批短信編號，需保證唯一，可空，建議為空phones :接收手機號碼，多個手機號碼用英文逗號分隔，最多500，不能為空content :短信內容，最多500漢字，不能為空subcode :擴展子號碼，可空sendtime :發送時間,格式yyyyMMddHHmm,可空輸 出 說 明返回的結果xml格式如下：v?xml version =1.0en cod ing =UTF-8?2c92825934837c4d0134837dcba001500 提交成功 字段說明：msgid :該批短信編號result:該批短信提交結果0提交成功1賬號無效2密碼錯誤3msgid

35、不唯一4存在無效手機號碼5手機號碼個數超過最大限制6短信內容超過最大限制7擴展子號碼無效（驗證格式和長度，不能超過20位）8發送時間格式無效9請求來源地址無效10內容包含敏感詞11余額不足97接入方式錯誤98系統繁忙99消息格式錯誤242.短信上行訪問地址：:8090 /http/sms/Deliver名稱deliver力 匕匕 號 厶冃獲取上行短信。每次調用間隔需大于30秒輸 入 說 明message參數xml格式如下：adm inbb43a2c4081bec02fca7b72f38e63021字段說明：accou nt:用戶賬號password :賬號密碼，需米用 MD5加密（小寫），如：加密后為bb43a2c4081bec02fca7b72f38e63021輸 出 說 明返回的結果xml格式如下：0 成功content 短信內容 55552011-11-11 11:11:11字段說明：result:接口調用結果0成功1賬號無效2密碼錯誤3請求太快9請求來源地址無效97接入方式錯誤98系統繁忙99消息格式錯誤如果result為0時sms標簽對將出現0到多次，否則sms標簽不出現。phone :上行手機號碼content :上行短信內容delivertime