MAS應用服務器webservice接口用戶手冊

1、IM移動信息機Web Service API接口用戶手冊MAS服務器Web Service API接口用戶手冊V1.0嘉訊軟件2006-3修訂記錄ID修訂歷史修改人日期初稿V1.0陳鐵鋼2006-4-1修改稿V1.1高樂平2006-12-121 簡介本協(xié)議用于IM與 通過API接入IM的客戶端的數(shù)據(jù)傳輸通訊?？s略語清單：client：所有通過Web Service 接口接入 IM 的客戶端IM(Information Machine)：信息機, 本文中特指短信API移動服務端1.1 API原理Web Service api 短信收發(fā)使用原理請參照 IM產品發(fā)布時附帶的文件IM移動信息機API2

2、.0開發(fā)手冊。本文檔不再重復闡述。本文檔解決的是 Web Service API使用方式說明。1.2 Web Service接口API功能概述1） MT短信發(fā)送；2） MO短信接收；3） 狀態(tài)報告接口；2 訪問sm webservice服務地址WSDL：/axis/services/SMsg?wsdl地址：/axis/services/SMsg注意：這里只是示例，實指用戶IM機器的IP地址。在IE中任意輸入以上兩個url地址，如可以訪問到服務（沒有出現(xiàn)異常），則表示sm webservice服務已正常啟動，可以進行以

3、下開發(fā)3 創(chuàng)建sm webservice 接口在web頁面中登陸信息機，進入系統(tǒng)管理接口管理新增頁面如下圖1 選擇接口類型為 web service 接口2 如果不需要回執(zhí)回執(zhí)要求一項選擇為不支持回執(zhí)3 短信回執(zhí)目標url 一項為客戶端被動接收回執(zhí)的URL，根據(jù)用戶自己需要填寫4 mo目標url 一項為客戶端被動接收MO的URL，根據(jù)用戶自己需要填寫接口說明5 如果不需要回執(zhí)和mo，短信回執(zhí)目標url和mo目標url可填空6 接口狀態(tài)選運行狀態(tài)，否則短信無法發(fā)送成功7 其他幾項用戶根據(jù)自己需要填寫4 Web Service接口方法說明4.1 sendSM方法方法說明：發(fā)送一條MT短信到一個手機

4、號碼/手機號碼集。public String sendSM(String apicode, String loginName, String loginPwd, String mobiles, String content, String smID )參數(shù)說明：參數(shù)描 述apicode接口編碼(必填)loginName接口創(chuàng)建時的接口登錄名(必填)loginPwd接口創(chuàng)建時的接口登錄密碼(必填)mobiles短信發(fā)送的目的手機號碼?？梢蕴顚懚鄠€，但必須以英文分號隔開(必填)如：13500000001” (必填)Content短信內容，超過260個字符部分會被截斷(必填

5、)smID短信ID，0到99999999中的某一整數(shù)。確保唯一后可以用來找到對應的回執(zhí)、回復。缺省值0。（可為空）4.2 sendWAPPUSHSM方法方法說明：發(fā)送一條MT WAPPUSH短信到一個手機號碼/手機號碼集。public String sendSM(String apicode, String loginName, String loginPwd, String mobiles, String title, String url,String smID )參數(shù)說明：參數(shù)描 述apicode接口編碼(必填)loginName接口創(chuàng)建時的接口登錄名(必填)loginPwd接口創(chuàng)建時的

6、接口登錄密碼(必填)mobiles短信發(fā)送的目的手機號碼?？梢蕴顚懚鄠€，但必須以英文分號隔開(必填)如：13500000001” (必填)title短信標題。urlWAP Push短信的URL，為“”或null時則發(fā)送常規(guī)短信。(必填)smID短信ID，0到99999999中的某一整數(shù)。確保唯一后可以用來找到對應的回執(zhí)、回復。缺省值0。（可為空）4.3 sendSM方法方法說明：發(fā)送一條MT短信到一個手機號碼/手機號碼集。public String sendSM(String apicode, String loginName, String loginPwd, St

7、ring mobiles, String content, long smID )參數(shù)說明：參數(shù)描 述apicode接口編碼(必填)loginName接口創(chuàng)建時的接口登錄名(必填)loginPwd接口創(chuàng)建時的接口登錄密碼(必填)mobiles短信發(fā)送的目的手機號碼?？梢蕴顚懚鄠€，但必須以英文分號隔開(必填)如：13500000001” (必填)Content短信內容，超過260個字符部分會被截斷(必填)smID短信ID，0到99999999中的某一整數(shù)。確保唯一后可以用來找到對應的回執(zhí)、回復(必填)4.4 sendSM方法方法說明：發(fā)送一條MT短信到一個手機號碼/手機

8、號碼集。public String sendSM(String apicode, String loginName, String loginPwd, String mobiles, String content, long smID，long srcID )參數(shù)說明：參數(shù)描 述apicode接口編碼(必填)loginName接口創(chuàng)建時的接口登錄名(必填)loginPwd接口創(chuàng)建時的接口登錄密碼(必填)mobiles短信發(fā)送的目的手機號碼。可以填寫多個，但必須以英文分號隔開(必填)如：13500000001” (必填)Content短信內容，超過260個字符部分會被截

9、斷(必填)smID短信ID，0到99999999中的某一整數(shù)。確保唯一后可以用來找到對應的回執(zhí)、回復。(必填)srcID終端源地址,缺省值為smID.(可為空)4.5 sendSM方法方法說明：發(fā)送一條MT短信到一個手機號碼/手機號碼集。public String sendSM(String apicode, String loginName, String loginPwd, String mobiles, String content, long smID,String url )參數(shù)說明：參數(shù)描 述apicode接口編碼(必填)loginName接口創(chuàng)建時的接口登錄名(必填)loginP

10、wd接口創(chuàng)建時的接口登錄密碼(必填)mobiles短信發(fā)送的目的手機號碼?？梢蕴顚懚鄠€，但必須以英文分號隔開(必填)如：13500000001” (必填)Content短信內容，超過260個字符部分會被截斷(必填)smID短信ID，0到99999999中的某一整數(shù)。確保唯一后可以用來找到對應的回執(zhí)、回復。(必填)urlWAP Push短信的URL，為“”或null時則發(fā)送常規(guī)短信。.(可為空)4.6 sendSM方法方法說明：發(fā)送一條MT短信到一個手機號碼/手機號碼集。public String sendSM(String apicode, String loginN

11、ame, String loginPwd, String mobiles, String content, long smID,long srcID,String url )參數(shù)說明：參數(shù)描 述apicode接口編碼(必填)loginName接口創(chuàng)建時的接口登錄名(必填)loginPwd接口創(chuàng)建時的接口登錄密碼(必填)mobiles短信發(fā)送的目的手機號碼?？梢蕴顚懚鄠€，但必須以英文分號隔開(必填)如：13500000001” (必填)Content短信內容，超過260個字符部分會被截斷(必填)smID短信ID，0到99999999中的某一整數(shù)。確保唯一后可以用來找到對

12、應的回執(zhí)、回復。(必填)srcID終端源地址,缺省值為smID.(可為空)urlWAP Push短信的URL，為“”或null時則發(fā)送常規(guī)短信。.(可為空)4.7 sendSM方法方法說明：發(fā)送一條MT WAPPUSH短信到一個手機號碼/手機號碼集。public String sendSM(String apicode, String loginName, String loginPwd, String mobiles, String content, String smID,String srcID,String url )參數(shù)說明：參數(shù)描 述apicode接口編碼(必填)loginName

13、接口創(chuàng)建時的接口登錄名(必填)loginPwd接口創(chuàng)建時的接口登錄密碼(必填)mobiles短信發(fā)送的目的手機號碼?？梢蕴顚懚鄠€，但必須以英文分號隔開(必填)如：13500000001” (必填)Content短信內容，超過260個字符部分會被截斷(必填)。smID短信ID，0到99999999中的某一整數(shù)。確保唯一后可以用來找到對應的回執(zhí)、回復。(必填)srcID終端源地址,缺省值為smID.(可為空)urlWAP Push短信的URL，為“”或null時則發(fā)送常規(guī)短信。.(可為空)注意：WAP PUSH 短信 URL 不能大于110字節(jié)，url和內容總長不能超過1

14、20字節(jié)。如果url超過110字節(jié)，則IM接收后可能做異常處理不予發(fā)送，如果總長超過120字節(jié)，則發(fā)送時標題內容將被截取。5 客戶端調用方法（MT發(fā)送短信）摘要：本章詳細介紹了如何使用客戶端組件提交發(fā)送短信請求采用Java語言開發(fā)，支持目前主流的各種平臺，包括Windows、Unix、Linux操作系統(tǒng)實例程序參考DemoFrame.java/* * 短信平臺客戶端編程實例 * * 描述: * 開發(fā)語言為JAVA，該說明適用于JAVA程序員 * 該實例適用于windows, Linux, 所有UNIX(可安裝JDK1.3以上版本和JCE)操作系統(tǒng)，不能用于手持設備。 * 注:如果使用JDK1.

15、4以上版本不需要額外安裝JCE。如果使用JDK1.3x，請安裝JCE。 * 該實例采用了Apache組織的axis項目的庫完成SOAP協(xié)議Over HTTP功能，版本是1.1RC2， * 你也可以采用其他你所熟悉的SOAP兼容庫。 * Apache AXIS的詳細介紹請參見/axis/ * 通過SSL發(fā)送短信的實現(xiàn)參照該方式自行解決 * 該程序的邏輯說明請參見短信平臺客戶端開發(fā)的相關文檔 * 該程序只作為參考實現(xiàn)，未考慮運行效率，請客戶端開發(fā)者根據(jù)自己的實際情況修改， * 例如盡量減少網(wǎng)絡連接請求次數(shù)等* 版本: 1.0.0*/l 使用步驟:（以下僅供參考

16、）1) 利用axis的wsdl2java工具生成java客戶端程序（建議使用axis 1_2以上版本）命令行為: java -cp "<axis_jar_lib>" org.apache.axis.wsdl.WSDL2Java <your_wsdl_url>例如：假設axis-1_2裝在E:ProgramFilesjava -cp "E:ProgramFilesaxis-1_2libaxis.jar;E:ProgramFilesaxis-1_2libaxis-ant.jar;E:ProgramFilesaxis-1_2libcommons-

17、discovery.jar;E:ProgramFilesaxis-1_2libcommons-logging.jar;E:ProgramFilesaxis-1_2libjaxrpc.jar;E:ProgramFilesaxis-1_2liblog4j-1.2.8.jar;E:ProgramFilesaxis-1_2libsaaj.jar;E:ProgramFilesaxis-1_2libwsdl4j-1.5.1.jar" org.apache.axis.wsdl.WSDL2Java :8080/axis/services/SMsg?wsdl p clie

18、nt(* -p 后面為生成的java類的包名，用戶可根據(jù)需要自己定義)注意：：8080實際填寫是IM機器的IP地址。2) 在c根目錄下生成client文件夾，里面有java客戶端代理程序 SMsg.java，SMsgService.java，SMsgServiceLocator.javaSMsgSoapBindingStub.java 3) 將這幾個java類導入你的開發(fā)工程,4) 如實例程序DemoFrame.java所示的進行調用 SMsgService service=new SMsgServiceLocator(); SMsg client=service.getSM

19、sg(); String result=client.sendSM(apiCode,loginName,loginPwd,mobiles,content,smId); 5）切記要引入lib目錄下的jar文件 6 接收MO和狀態(tài)報告的前置條件6.1 前置條件確保API用戶已經創(chuàng)建webservice接口，API與上行相關的信息，有以下幾點：Ø 短信回執(zhí)目標url：此為您的上行接收邏輯的名稱，如http:/localhost:8080/im/UPReceiver.aspØ Mo目標url：此為您的上行接收邏輯的名稱，如http:/localhost:8080/im/UPRece

20、iver.asp7 接收MO上行短信摘要：本章詳細介紹了如何接收用戶手機的上行短信7.1 上行短信的XML定義<?xml version="1.0" encoding="UTF-8"?><im apicode="1" > <sms><deliver mobile="quot; sm_id="1" content="請假一天"/><deliver mobile="quot; s

21、m_id="1" content="請假3天"/> </sms></im>節(jié)點說明：節(jié) 點描 述apicode接口編號mobile發(fā)送短信的手機號碼sm_idMO短信的短信IDcontent短信內容1)移動服務器端的上行組件將上行短信組織成XML，然后根據(jù)API調用程序所在地址主動提交給特定的jsp文件處理。2)服務端每次最多只返回200個MO短信。7.2 如何接收上行XML在此以java（jsp）為例:<% page contentType="text/html; charset=GBK" %&g

22、t;<html><head><title>jsp1</title></head><body bgcolor="#ffffff"><h1>begin</h1><% ServletInputStream sin = request.getInputStream(); byte buf = new byte51200; int index = 0; while (true) int ch = sin.read(); if (ch = -1) break; bufindex+ =

23、(byte)ch; /out.println(ch); byte buf2 = new byteindex; System.arraycopy(buf, 0, buf2, 0, index); String info = new String(buf2, "GBK"); out.println(info);/*j將得到的字符串寫入xml文件 byte buf3 = info.trim().getBytes("GBK"); String temp = new String(buf3, "iso8859-1")File f=new Fil

24、e("xiaogao1.xml"); if(f.exists() f=new File("aa.xml"); try DataOutputStream output = new DataOutputStream(new FileOutputStream(f);output.writeBytes(temp);catch (Exception e)/ TODO Auto-generated catch blocke.printStackTrace();*/%><h1>end</h1></body></html&

25、gt;本節(jié)介紹了如何撰寫接收上行短信XML流的jsp文件(linux/unix)。其中就就jsp只是簡單的將此XML流存成文件，企業(yè)可以根據(jù)自己的需要做更多的事情。7.3 小結本章介紹了如何接收上行短信，可以將此理解為移動服務器向企業(yè)客戶端PUSH(推)的過程。8 接收狀態(tài)報告接收狀態(tài)報告的過程和接收上行短信處理方法一致。8.1 狀態(tài)報告的XML定義<?xml version="1.0" encoding="UTF-8"?><im apicode ="1"> <sms><report mobile="quot; sm_id=&q