1、06:889006:8890行業短信平臺行業短信平臺接口手冊接口手冊產品名稱產品名稱行業短信平臺行業短信平臺發布日期發布日期2011-052011-05河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 2 頁 共 26 頁目目 錄錄1 1、引言引言.3 31.1.目的.31.2.修改歷史記錄.31.3.名稱解釋.32 2、短信短信.4 42.1.HTTP接口.42.1.1. 短信下行.42.1.2. 短信上行.72.1.3. 短信狀態報告.82.1.4. 查詢余額.92.2.API接口 .102.3.WEBSERVICE接口（不推薦）.14

2、2.3.1. 自定義數據結構.142.3.2. 短信下行（發送多條內容相同的短信）.162.3.3. 短信下行（發送多條內容不同的短信）.172.3.4.獲取上行.172.3.5.獲取狀態報告（單條）.182.3.6.獲取狀態報告（多條）.182.3.7. 獲取余額.192.4.WEBSERVICE接口(新，推薦使用).192.4.1. 自定義數據結構.192.4.2. 短信下行（發送一條或者多條內容相同的短信）.192.4.3. 短信下行（發送內容不同的短信）.202.4.4.獲取上行.212.4.5.獲取狀態報告.222.4.6. 獲取余額.232.4.7.短信 webservice（新）

3、錯誤碼.242.5.WEBSERVICE接口(支持上下行子號碼).242.5.1. 自定義數據結構.242.5.2. 短信下行（發送一條或者多條內容相同的短信）.252.5.3. 短信下行（發送內容不同的短信）.262.5.4.獲取上行.272.5.5.獲取狀態報告.282.5.6. 獲取余額.292.5.7.短信 webservice 錯誤碼.30河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 3 頁 共 26 頁1 1、 引言引言. 目的目的該接口手冊編寫目的在于描述短信平臺 CTC-EMP（以下簡稱 CTC-EMP）具體的接口協議，供接口用戶進行接口的對接開發。1.

4、2.1.2. 修改歷史記錄修改歷史記錄版版 本本修改人修改人日日 期期描描 述述5.0.1顧黎杰2006/8/10創建文檔。5.0.2顧黎杰2008/6/20增加短信 api 接口。5.0.3顧黎杰2010/5/5細化接口返回參數。5.0.3趙鴻2011/5/6WebService 接口(支持上下行子號碼)5.3.8王鵬2011/8/26細化 HTTP 下行 SUBCODE 參數描述. 名稱名稱解釋解釋縮略語縮略語英文全名英文全名中文全名中文全名SMSShort Messaging Service短消息服務MMSMultimedia Message Service多媒體消息API

5、Application Programming Interface應用程序編程接口MOMessage Original消息上行MTMessage Terminal消息下行SPService Provider服務提供商CPContent Provider內容提供商河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 4 頁 共 26 頁2 2、 短信短信. http 接口接口.1.1. 短信下行短信下行功能：下發單條或者多條內容相同的短信。地址： 31:8080/emp/http/SendSms。建議采用 post 方法提交請求。

6、請求參數定義如下： 參數名稱描述字段值Account帳號String，不空。Password密碼String，不空（需 MD5 加密，32 位，加密后字母全部為小寫，例如：“ 加密后應該等于“cbff36039c3d0212b3e34c23dcde1456”用戶可以用此例子驗證加密方法是否正確） 。SubCode子號碼String，可以為空。格式為企業帳號+子號碼。例如：如果平臺號碼為“10650300” ，企業帳號為 2，子號碼為“22” ，則 SubCode 設置為“222” ，短信將以“10650300222”號碼下發給手機用戶(注：此功能需要通道支持)。Phone手機號碼String，

7、不空，支持多號碼，號碼之間用英文逗號隔開，最多 100 個。如13900000000。Content短信內容String，不空 。GBK 編碼Java 例:.URLEncoder.encode(Content, UTF-8)。WappushurlWappushurlWappush 地址，如果需要發送Wappush，則 Content 表示 titleSendTime定時發送時間String，可以為空，為空就是立即發送。定時發送格式為年月日時分，如：200803201615。返回參數定義如下：河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 5 頁 共 26 頁參

8、數名稱描述response0：成功條數；-1：帳號不存在，請檢查用戶名或者密碼是否正確；-2：賬戶余額不足；-3：帳號已被禁用；-4：ip 鑒權失敗（需要 ip 校驗的場合） ；-8：缺少請求參數或參數不正確（請檢查用戶名，密碼，下發號碼，下發內容是否為空，或者下發號碼數量是否大于100 個） ；-9：內容不合法（含有非法內容，請檢查下發內容） 。-10：賬戶當日發送短信量已經超過允許的每日最大發送量（賬戶被限制每日發送短信數量的情況有用）phone手機號。smsID短信 ID（用于匹配狀態報告） 。下發實例（java）：import java.io.BufferedReader;import

9、 java.io.InputStreamReader;import java.io.OutputStream;import .HttpURLConnection;import .URL;import java.security.MessageDigest;public class HttpSend public static void main(String args) try Long startt = System.currentTimeMillis(); / 短信內容String _content = 測試,見諒;/ 用UTF-8編碼執行URLEncode_content = .URLE

10、ncoder.encode(_content, UTF-8);/ 密碼加密String pass = MD5Encode(10);String _url = 1:8080/ctc-emassh/http/SendSms;String _param = Account=10&Password= + pass+ &Phoneamp;Content= + _content+ &SubCode=&SendTime=;URL url = null;HttpURLConnection urlConn = null;u

11、rl = new URL(_url);urlConn = (HttpURLConnection) url.openConnection();河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 6 頁 共 26 頁urlConn.setRequestMethod(POST);urlConn.setDoOutput(true);OutputStream out = urlConn.getOutputStream();out.write(_param.getBytes(GBK);out.flush();out.close();BufferedReader rd = new BufferedRea

12、der(new InputStreamReader(urlConn.getInputStream(), GBK);StringBuffer sb = new StringBuffer();int ch;while (ch = rd.read() -1) sb.append(char) ch);System.out.println(sb);rd.close();Long end = System.currentTimeMillis();System.out.println(發送 短信 耗時： + (end - startt); catch (Exception ex) System.out.pr

13、int(ex);public static String MD5Encode(String sourceString) String resultString = null;try resultString = new String(sourceString);MessageDigest md = MessageDigest.getInstance(MD5);resultString = byte2hexString(md.digest(resultString.getBytes(); catch (Exception ex) return resultString;public static

14、 final String byte2hexString(byte bytes) StringBuffer bf = new StringBuffer(bytes.length * 2);for (int i = 0; i bytes.length; i+) if (bytesi & 0 xff) 0 x10) bf.append(0);bf.append(Long.toString(bytesi & 0 xff, 16);河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 7 頁 共 26 頁return bf.toString();失敗返回頁面示例： - -8 成功返回

15、頁面示例： - 2 -2c92811a29a0c90c0129a0ca984e0016 -2c92811a29a0c90c0129a0ca984e0015 .1.2. 短信上行短信上行功能：接收若干條手機用戶的上行短信（一次最多十條） 。地址： 31:8080/emp/http/GetSms。建議采用 post 方法提交請求。調用短信上行間隔時間不小于 30 秒。請求參數定義如下：參數名稱描述字段值Account帳號String，不空。Password密碼String，不空（需 MD5 加密）

16、 。返回參數定義如下：參數名稱描述response大于 0：上行短信的條數，一次最多取 10 條；0：沒有上行短信；-1：帳號登陸失敗；河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 8 頁 共 26 頁-3：此帳號被禁用；-4：ip 鑒權失敗；-8：缺少請求參數。-9：訪問速度太快，每次訪問間隔不能小于 30 秒phone手機號。content短信內容；已經用 .URLEncoder.encode()編碼；需要用 .URLDecoder.decode()解碼。sendTime上行時間。無短信或者參數錯誤返回頁面示例： - 0 成功返回短信頁面示例：（一次最多取 10 條）- 3- 1

17、376612345678test2009-02-06 09:01:33.0- 1386612345678%E6%B5%8B%E8%AF%952009-02-06 09:01:33.0- 1396612345678abc2009-02-06 09:01:33.0.1.3. 短信狀態報告短信狀態報告功能：根據 SmsID 返回短信是否成功發送到用戶手機。地址： 31:8080/emp/http/GetReport。建議采用 post 方法提交請求。調用短信狀態報告間隔時間不小于 30 秒。河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 9

18、頁 共 26 頁請求參數定義如下：參數名稱描述字段值Account帳號String，不空。Password密碼String，不空（需 MD5 加密） 。SmsID消息 IDString，不空。返回參數定義如下：參數名稱描述response大于 0：此消息 ID 所對應的狀態報告條數。最多 100 條；0：沒有此消息 ID 的狀態報告；-1：帳號登陸失敗；-3：此帳號被禁用；-4：ip 鑒權失敗；-8：缺少請求參數。-9：訪問速度太快，每次訪問間隔不能小于 30 秒phone手機號。smsID消息 ID。stat狀態報告0：成功；2：發送失敗。請求錯誤返回頁面示例： - -8 請求成功返回頁面示

19、例： - 1 -2c92812d1ebf8704011ebf939ba80004 0 河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 10 頁 共 26 頁.1.4. 查詢余額查詢余額功能：查詢剩余短信的條數。地址： 31:8080/emp/http/GetBalance。建議采用 post 方法提交請求。調用查詢余額間隔時間不小于 30 秒。請求參數定義如下：參數名稱描述字段值Account帳號String，不空。Password密碼String，不空（需 MD5 加密） 。返回參數定義如下：參數名稱描述re

20、sponse-1：帳號登陸失敗；-3：此帳號被禁用；-4：ip 鑒權失敗；-8：缺少請求參數。sms短信余額。mms彩信余額。返回頁面示例： - 10002000 . api 接口接口相關 jar 包包括：ctc-smsclient.jar，ctc-message.jar，ctc-slidewindow.jar，ctc-sync.jar，ctc-util.jar。注意：只有外部企業才能使用此接口注意：只有外部企業才能使用此接口名稱initConn功能連接初始化。接口方法public int initConn(String host, int port, String user,

21、String password) 河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 11 頁 共 26 頁輸入說明host：CTC-EMP 的 ip；port：CTC-EMP 的端口；user：接口用戶名；password：接口密碼。輸出說明0成功1已經登陸2用戶名錯誤3密碼錯誤4客戶端 ip 錯誤（需要校驗 ip 的時候需要）5 其他名稱sendSms功能發送短信。接口方法public boolean sendSms(String from, String to, String msg) 輸入說明from：子號碼，一般不填寫；to：手機號碼，支持多號碼，以英文逗號隔開。建議一次最多10

22、0 個；msg：短信內容。輸出說明true：成功；false：失敗。名稱onSubmitedSMS功能接收下行短信響應。sendSms 方法不直接返回下行響應，由此方法返回，此方法為回調方法，不需要手動調用。接口方法public boolean onSubmitedSMS(ISubmitMsg arg0) 輸入說明arg0：下行數據結構，具體支段見示例。輸出說明true：成功；false：失敗。河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 12 頁 共 26 頁名稱onDeliverSMS功能接收上行短信。此方法為回調方法，不需要手動調用。接口方法public boolean onD

23、eliverSMS(IDeliverMsg arg0) 輸入說明arg0：上行數據結構，具體支段見示例。輸出說明true：成功；false：失敗。名稱onMTReportSMS功能接收狀態報告。此方法為回調方法，不需要手動調用。接口方法public boolean onMTReportSMS(IReportMsg arg0)輸入說明arg0：狀態報告數據結構，具體支段見示例。輸出說明true：成功；false：失敗。示例程序：import com.chinatricom.message.IDeliverMsg;import com.chinatricom.message.IReportMsg;

24、import com.chinatricom.message.ISubmitMsg;import com.chinatricom.slidewindow.SMSCallback;import com.chinatricom.smsclient.ctcpp.CtcppChannel;import com.chinatricom.smsclient.message.DeliverMsg;import com.chinatricom.smsclient.message.ReportMsg;import com.chinatricom.smsclient.message.SubmitMsg;/* *

25、title: 調用CTC-SMS API客戶端接口 SMSUtil.java create on 2010-10-26 copyright (c) * 2010-10-26 * * author * version 1.0 */public class SMSUtil implements SMSCallback public static CtcppChannel _chan = null;河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 13 頁 共 26 頁static / 相關參數定義SMSUtil _client = new SMSUtil();String host = 12

26、; / 調用IP地址int port = 28013; / 調用IP地址的端口String user = 8888; / 用戶名String passwd = 8888;/ 密碼int wndSize = 16;int timeout = 60 * 1000; / 連接超時時間int trys = 3;int speed = 0;/ 記錄日志System.out.println(start);/ 開啟通道_chan = new CtcppChannel(host, port, user, passwd, 1, wndSize, timeout,trys, speed, _clie

27、nt, 0, 0, 1, 1);_chan.start();/* * 這個函數接收上行短信，短信的各個字段都放在DeliverMsg */public boolean onDeliverSMS(IDeliverMsg arg0) DeliverMsg msg = (DeliverMsg) arg0;if (msg != null) System.out.println(收到deliverMsg:phone= + msg.getFrom() + ,內容=+ msg.getMsg() + ,to= + msg.getTo();return true;/* * 這個函數接收下發短信的狀態報告，它通過

28、msgid關聯到下行短信 result : 0成功 1等待發送 2失敗 */public boolean onMTReportSMS(IReportMsg arg0) ReportMsg msg = (ReportMsg) arg0;if (msg != null) System.out.println(收到repot: result= + msg.getResult() + );河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 14 頁 共 26 頁return true;/* * 這個函數接收下行短信的response，SubmitMsg里面有了result和msgId,這里的msg

29、就是_chan.submit(_msg) * 里面的_msg。 result = 0 表示成功， 其他均為失敗。 */public boolean onSubmitedSMS(ISubmitMsg arg0) SubmitMsg msg = (SubmitMsg) arg0;if (msg != null) System.out.println(收到submit response:result + =+ msg.getResult() + , msgid= + msg.getMsgId();return true;/* * 下發方法入口 */public static void sendSMS

30、(String phoneNumber, String smsContext) try SubmitMsg _msg = new SubmitMsg();_msg.setChanId(1);_msg.setFrom(1);_msg.setTo(phoneNumber);_msg.setMsg(smsContext);_chan.submit(_msg); catch (Exception e) e.printStackTrace(); finally public static void main(String args) SMSUtil.sendSMS test);

31、. WebService 接口接口地址：31:8080/emp/services/SmsNewOperator河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 15 頁 共 26 頁.3.1. 自定義數據結構自定義數據結構MtNewMessage參數名稱類型說明smsIdString消息序號，用來取狀態報告時候匹配，可以為空，建議不填寫，為空時服務端會返回一個唯一的消息序號。phoneNumberString手機號碼。支持多號碼，號碼之間用英文逗號隔開,建議最多 100 個。如13900000000

32、。contentString短信內容。scheduleTimeDate下行時間，可以為空。WappushurlStringWappush 地址，如果需要發送 Wappush，則 Content 表示 title.3.2. 短信下行（發送一條或者多條內容相同的短信）短信下行（發送一條或者多條內容相同的短信）名稱sendSms功能發送一條或則多條內容相同的短信。接口方法sendSms(String account, String password, MtNewMessage message,StringHolder sendResMsg, StringHolder errMsg) 輸

33、入說明account 用戶賬號；password 用戶密碼（用 MD5 加密，32 位，加密后字母全部為小寫，例如：“ 加密后應該等于“cbff36039c3d0212b3e34c23dcde1456”可以用此例子驗證加密方法是否正確） ；message對象，詳情請參照自定義數據結構：MtNewMessage。輸出說明sendResMsg：發送情況返回 （當errMsg 不為負值時該值有效）格式（無換行符）北電信行業短信平臺-接口手冊 中國電信河北分公司 第 16 頁 共 26 頁2c9281e22c1ac7c2012c1adc8bdb0021132-7errMsg：

34、輸出參數，小于零時表示下發錯誤，詳情見錯誤碼.3.3. 短信下行（發送內容不同的短信）短信下行（發送內容不同的短信）名稱batchSendSms功能發送一條或則多條內容相同的短信。接口方法batchSendSms(String account, String password, MtNewMessage message,StringHolder sendResMsg, StringHolder errMsg) 輸入說明account 用戶賬號；password 用戶密碼（用 MD5 加密，32 位，加密后字母全部為小寫，例如：“ 加密后應該等于“cbff36039c3d0212b

35、3e34c23dcde1456”可以用此例子驗證加密方法是否正確） ；message對象數組，詳情請參照自定義數據結構：MtNewMessage。輸出說明sendResMsg：發送情況返回 （當errMsg 不為負值時該值有效）格式（無換行符）北電信行業短信平臺-接口手冊 中國電信河北分公司 第 17 頁 共 26 頁2c9281e22c5d9f77012c5da2d0b7001b150007927992c9281e22c5d9f77012c5da2d0c0001c errMsg：輸出參數，小于零時表示下發錯誤，詳情見錯誤碼.3.4. 獲取上行獲取上行調

36、用短信上行間隔時間不小于 30 秒。名稱getSms功能獲取上行短信，一次最多取 10 條。接口方法getSms(String account, String password, StringHolder resMsg,StringHolder errMsg)輸入說明account 用戶賬號；password 用戶密碼（用 MD5 加密，32 位，加密后字母全部為小寫，例如：“ 加密后應該等于“cbff36039c3d0212b3e34c23dcde1456”可以用此例子驗證加密方法是否正確） 。輸出說明resMsg：返回上行短信（當errMsg 不為負值時該值有效）格式（無換行符）：1500

37、0792799河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 18 頁 共 26 頁Test MO! 測試 Deliver 消息est MO! 測試 Deliver 消息!沒有上行時返回：errMsg：輸出參數，小于零時表示下發錯誤，詳情見錯誤碼.3.5. 獲取狀態報告獲取狀態報告調用短信狀態報告間隔時間不小于 30 秒。名稱getReport功能獲取一條或者多條狀態報告。接口方法getReport(String account, String password,MtNewMessage message, StringHolder reportM

38、sg, StringHolder errMsg)輸入說明account 用戶賬號；password 用戶密碼（用 MD5 加密，32 位，加密后字母全部為小寫，例如：“ 加密后應該等于“cbff36039c3d0212b3e34c23dcde1456”可以用此例子驗證加密方法是否正確） ；MtNewMessage，詳情請參照自定義數據結構：MtNewMessage,包含消息序號和手機號碼的對象數組。 （只需要填寫smsId 和 phoneNumber 字段） 。輸出說明reportMsg: 返回狀態報告（當 errMsg 不為負值時該值有效）格式（無換行符）：河北電信行業短信平臺-接口手冊 中

39、國電信河北分公司 第 19 頁 共 26 頁138877878782c9281e22bf60182012bf6025949001a0138877878792c9dd1e22aa6018dd12bf60ff59490550無狀態報告時返回：errMsg: 輸出參數，小于零時表示下發錯誤，詳情見錯誤碼.3.6. 獲取余額獲取余額調用獲取余額報告間隔時間不小于 30 秒。名稱getBalance功能獲取帳號余額。接口方法getBalance(String account, String password,StringHolder resMsg, StringHolder errMsg)

40、輸入說明account 用戶賬號；password 用戶密碼（用 MD5 加密，32 位，加密后字母全部為小寫，例如：“ 加密后應該等于“cbff36039c3d0212b3e34c23dcde1456”可以用此例子驗證加密方法是否正確） 。輸出說明resMsg：返回賬戶余額（當 errMsg 不為負值時該值有效）格式（無換行符）：河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 20 頁 共 26 頁043216errMsg: 輸出參數，小于零時表示下發錯誤，詳情見錯誤碼.3.7. 短信短信 webservicewebservice（新）錯誤碼（新）錯誤碼-1：輸入參數不

41、正確，請檢查賬戶，密碼，等輸入參數是否為空-2：賬戶不存在，請檢查用戶名密碼是否正確-3：賬戶已經超過每日發送短信限制數量（當賬戶被限制每日發送量時有用）-4：客戶端 ip 地址不正確（當需要 ip 校驗時）-5：smsId 與數據庫重復（下發短信時，如果smsId 由客戶端傳入，該參數不能重復）-6：內容含有非法關鍵字，請檢查下發內容。-7：對應的號碼下發失敗，下發號碼為空或其他錯誤，導致該號碼發送失敗. WebService 接口接口(支持上下行子號碼支持上下行子號碼)地址： 31:8080/emp/services/SmsNewOpera

42、toraddsubCode前提：下發通道支持子號碼.4.1. 自定義數據結構自定義數據結構MtNewMessage參數名稱類型說明smsIdString消息序號，用來取狀態報告時候匹配，可以為空，建議不填寫，為空時服務端會返回一個唯一的消息序號。phoneNumberString手機號碼。支持多號碼，號碼之間用英文逗號隔開,建議最多 100 個。如13900000000。contentString短信內容。scheduleTimeDate下行時間，可以為空。WappushurlStringWappush 地址，如果需要發送 Wappush，則 Conte

43、nt 表示 title河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 21 頁 共 26 頁.4.2. 短信下行（發送一條或者多條內容相同的短信）短信下行（發送一條或者多條內容相同的短信）名稱sendSms功能發送一條或則多條內容相同的短信。接口方法sendSms(String account, String password, MtNewMessage message,String subCode,StringHolder sendResMsg, StringHolder errMsg) 輸入說明account 用戶賬號；password 用戶密碼（用 MD5 加密，3

44、2 位，加密后字母全部為小寫，例如：“ 加密后應該等于“cbff36039c3d0212b3e34c23dcde1456”可以用此例子驗證加密方法是否正確） ；subCode :子號碼，需要通道支持，手機終端用戶收到的信息發送號碼將是長號碼 + 子號碼( account + 自定義子號碼)message對象，詳情請參照自定義數據結構：MtNewMessage。輸出說明sendResMsg：發送情況返回 （當errMsg 不為負值時該值有效）格式（無換行符）：150000000002c9281e22c1ac7c2012c1adc8bdb0021132-7errMsg：輸出參數，小于零時表示下發錯

45、誤，詳情見錯誤碼.4.3. 短信下行（發送內容不同的短信）短信下行（發送內容不同的短信）名稱batchSendSms河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 22 頁 共 26 頁功能發送一條或則多條內容相同的短信。接口方法batchSendSms(String account, String password, MtNewMessage message, String subCode,StringHolder sendResMsg, StringHolder errMsg) 輸入說明account 用戶賬號；password 用戶密碼（用 MD5 加密，32 位，

46、加密后字母全部為小寫，例如：“ 加密后應該等于“cbff36039c3d0212b3e34c23dcde1456”可以用此例子驗證加密方法是否正確） ；subCode :子號碼，需要通道支持，手機終端用戶收到的信息發送號碼將是長號碼 + 子號碼message對象數組，詳情請參照自定義數據結構：MtNewMessage。輸出說明sendResMsg：發送情況返回 （當errMsg 不為負值時該值有效）格式（無換行符）：150007927992c9281e22c5d9f77012c5da2d0b7001b150007927992c9281e22c5d9f77012c5da2d0c0001c 河北電信行業短信平臺-接口手冊 中國電信河北分公司 第 23 頁 共 26 頁errMsg：輸出參數，小于零時表示下發錯誤，詳情見錯誤碼.4.4. 獲取上行獲取上行調用短信上行間隔時間不小于 30 秒。名稱getSms功能獲取上行短信，一次最多取 10 條。接口方法getSms(String account, String password, StringHolder resMsg,StringHolder errMsg)輸入說明account 用戶