MAS應(yīng)用服務(wù)器webservice接口用戶手冊

1、mas 服務(wù)器 web service api 接 口用戶手冊v1.0嘉訊軟件2006-3修訂記錄id修訂歷史修改人日期初稿v1.0陳鐵鋼2006-4-1修改稿vi.1高樂平2006-12-121簡介木協(xié)議用于im與通過api接入im的客戶端的數(shù)據(jù)傳輸通訊。縮略語清單：client：所有通過web service接口接入im的客戶端lm(information machine)：信息機(jī)，本文中特指短信api移動(dòng)服務(wù)端1.1 api原理web service api短信收發(fā)使用原理請參照im產(chǎn)品發(fā)布時(shí)附帶的文件im移動(dòng)信息機(jī) api2.0開發(fā)手冊。本文檔不再重復(fù)闡述。本文檔解決的是web ser

2、vice api使用方式說明。1. 2 web service 接口 api 功能概述1)mt m信發(fā)送；2)mo短信接收;3)狀態(tài)報(bào)告接口;2訪問sm webservice服務(wù)地址wsdl： http:/127. 0. 0. 1/axis/services/smsg?wsdl地址:http:/127. 0. 0. 1/axis/services/smsg注意：這里127. 0. 0.1只是示例，實(shí)指用戶im機(jī)器的ip地址。在1e中任意輸入以上兩個(gè)url地址，如可以訪問到服務(wù)(沒有出現(xiàn)界常)，則表示sm wcbservice服務(wù)已正常啟動(dòng)，可以進(jìn)行以下開發(fā)3 創(chuàng)建 sm webservice

3、接口在web頁面屮登陸信息機(jī)，進(jìn)入系統(tǒng)管理一接i i管理新增頁血如下圖新増接口接口編碼：smapi接口名稱：smapi接口類型：db接口 api接口q web service接口socket接口短信子碼：手機(jī)指令：sm回執(zhí)要求：支持回執(zhí)e不支持回執(zhí)登錄用戶：smapi登錄密碼：接口狀態(tài)：運(yùn)行狀態(tài)a調(diào)試狀態(tài)短信回執(zhí)目標(biāo)url :http :/:8080/test1. jspm淚標(biāo)url :http 7/:8080/test2 .jsp保存返回1. 選擇接口類型為web service接口2. 如果不需要回執(zhí)回執(zhí)要求一項(xiàng)選擇為不支持回執(zhí)3. 短信|”|執(zhí)目標(biāo)ur

4、l 一項(xiàng)為容戶端被動(dòng)接收回執(zhí)的url,根據(jù)用戶白己需要填寫4. m（）h標(biāo)url 一項(xiàng)為客戶端被動(dòng)接收mo的url,根據(jù)用戶自己需耍填寫接口說明5. 如果不需要回執(zhí)和mo,短信回執(zhí)目標(biāo)url和mo目標(biāo)url可填空6. 接口狀態(tài)選運(yùn)行狀態(tài),否則短信無法發(fā)送成功7. 其他幾項(xiàng)用戶根據(jù)自己需要填寫4 web service接口方法說明4. 1 sendsm 方法方法說明：發(fā)送一條mt短信到一個(gè)手機(jī)號(hào)碼/手機(jī)號(hào)碼集。public string sendsm(string apicode,string loginnaine,string loginpwd,string mobiles,string co

5、ntent,string smtd)參數(shù)說明:參數(shù)描述apicode接口編碼（必填）loginname接口創(chuàng)建時(shí)的接口登錄名（必填）loginpwd接口創(chuàng)建時(shí)的接口登錄密碼（必填）mobiles短信發(fā)送的目的于機(jī)號(hào)碼?？梢蕴顚懚鄠€(gè)，但必須以 英文分號(hào)隔開（必填）如: （必填）content短信內(nèi)容，超過260個(gè)字符部分會(huì)被截?cái)啵ū靥睿﹕mid短信id, 0到99999999中的某一整數(shù)。確保唯一后可 以用來找到對(duì)應(yīng)的1叫執(zhí)、冋復(fù)。缺省值0。（可為空）4. 2 sendwappushsm 方法方法說明：發(fā)送一條mt wappush短信到一個(gè)手機(jī)

6、號(hào)碼/手機(jī)號(hào)碼集。public string sendsm(string apicodc,參數(shù)說明：string loginname,string loginpwd,string mobiles,string title,string url,string smid)參數(shù)描述apicode接口編碼（必填）loginname接口創(chuàng)建時(shí)的接口登錄名（必填）loginpwd接口創(chuàng)建時(shí)的接口登錄密碼（必填）mobiles短信發(fā)送的目的于機(jī)號(hào)碼?？梢蕴顚懚鄠€(gè)，但必須以 英文分號(hào)隔開（必填）如: （必填）title短信標(biāo)題。urlwap push短信的u

7、rl,為“”或null時(shí)則發(fā)送常規(guī) 短信。（必填）smid短信id, 0到99999999中的某一整數(shù)。確保唯一后可 以用來找到對(duì)應(yīng)的冋執(zhí)、回復(fù)。缺省值0。（可為空）4. 3 sendsm 方法方法說明：發(fā)送一條mt短信到一個(gè)于機(jī)號(hào)碼/手機(jī)號(hào)碼集。public string sendsm（string apicode,參數(shù)說明：string loginname, string loginpwd, string mobiles, string content, long smtd)參數(shù)描述apicode接口編碼（必填）loginname接口創(chuàng)建時(shí)的接口背錄名（必填）loginpwd接口創(chuàng)建時(shí)的接

8、口登錄密碼（必填）mobiles矩信發(fā)送的冃的手機(jī)號(hào)碼。町以填寫多個(gè)，但必須以 英文分號(hào)隔開（必填）如： （必填）content短信內(nèi)容，超過260個(gè)字符部分會(huì)被截?cái)啵ū靥睿﹕mid矩信id, 0到99999999中的某一整數(shù)。確保唯一后可 以用來找到對(duì)應(yīng)的1叫執(zhí)、回復(fù)（必填）4. 4 sendsm 方法方法說明：發(fā)送一條mt短信到一個(gè)手機(jī)號(hào)碼/手機(jī)號(hào)碼集。public string sendsm（string apicode,參數(shù)說明：string loginname, string loginpwd,string mobiles, str

9、ing content, long smid, long srcid)apicode接口編碼（必填）loginname接口創(chuàng)建時(shí)的接口登錄名（必填）loginpwd接口創(chuàng)建時(shí)的接口登錄密碼（必填）mobiles短信發(fā)送的口的手機(jī)號(hào)碼?？梢蕴顚懚鄠€(gè)，但必須以英 文分號(hào)隔開（必填）如: 1350000000 lw （必填）content短信內(nèi)容，超過260個(gè)字符部分會(huì)被截?cái)啵ū靥睿﹕mid短信id, 0到99999999中的某一整數(shù)。確保唯一后可 以用來找到對(duì)應(yīng)的回執(zhí)、回復(fù)。（必填）srcid終端源地址，缺省值為smid.（可為空）4. 5 sendsm 方法方法說明：發(fā)

10、送一條mt短信到一個(gè)于機(jī)號(hào)碼/手機(jī)號(hào)碼集。public string sendsm(string apicode,string loginname,string loginpwd,string mobiles,string content, long smid,string url) 參數(shù)說明：參數(shù)描述apicode接口編碼（必填）loginname接口創(chuàng)建時(shí)的接口登錄名（必填）loginpwd接口創(chuàng)建吋的接口登錄密碼（必填）mobiles短信發(fā)送的目的手機(jī)號(hào)碼。可以填寫多個(gè)，但必須以 英文分號(hào)隔開（必填）如： （必填）content短信內(nèi)容

11、，超過260個(gè)字符部分會(huì)被截?cái)啵ū靥睿﹕mid短信id, 0到99999999中的某一整數(shù)。確保唯一后可 以用來找到對(duì)應(yīng)的冋執(zhí)、回復(fù)。（必填）urlwap push短信的url,為“”或null時(shí)則發(fā)送常規(guī) 短信。.（可為空）4. 6 sendsm 方法方法說明：發(fā)送一條mt短信到一個(gè)手機(jī)號(hào)碼/手機(jī)號(hào)碼集。public string sendsm（string apicode,參數(shù)說明：string loginname,string loginpwd,string mobiles,string content, long smld, long srcld,string url)參數(shù)描述apic

12、ode接口編碼（必填）loginname接口創(chuàng)建時(shí)的接口登錄名（必填）loginpwd接口創(chuàng)建吋的接口登錄密碼（必填）mobiles短信發(fā)送的11的手機(jī)號(hào)碼?？梢蕴顚懚鄠€(gè)，但必須以 英文分號(hào)隔開（必填）如： （必填）content短信內(nèi)容，超過260個(gè)字符部分會(huì)被截?cái)啵ū靥睿﹕mid矩信id, 0到99999999中的某一整數(shù)。確保唯一后可 以用來找到對(duì)應(yīng)的回執(zhí)、回復(fù)。（必填）srcid終端源地址，缺省值為smid.（可為空）urlwap push短信的url,為“”或null時(shí)則發(fā)送常規(guī) 短信。（可為空）4. 7 sendsm 方法方法說明

13、：發(fā)送一條mt wappush短信到一個(gè)手機(jī)號(hào)碼/手機(jī)號(hào)碼集。 public string sendsm(string apicode,string loginname,string loginpwd,string mobiles,string content,string smld,string srcld,string url參數(shù)說明:參數(shù)描述apicode接口編碼（必填）loginname接u創(chuàng)建時(shí)的接u登錄名（必填）loginpwd接口創(chuàng)建時(shí)的接口登錄密碼（必填）mobiles矩信發(fā)送的h的手機(jī)號(hào)碼。對(duì)以填寫多個(gè)，但必須以 英文分號(hào)隔開（必填）如： 13500

14、000001” （必填）content短信內(nèi)容，超過260個(gè)字符部分會(huì)被截?cái)啵ū靥睿?。smid短信id, 0到99999999中的某一整數(shù)。確保唯一后可 以用來找到對(duì)應(yīng)的回執(zhí)、回復(fù)。（必填）srcid終端源地址，缺省值為smid.（可為空）urlwap push短信的url,為“”或null吋則發(fā)送常規(guī) 短信。（可為空）注意：wap push短信url不能大于110字節(jié)，url和內(nèi)容總長不能超過120字節(jié)。如果ml超過110 字節(jié)，則im接收后可能做異常處理不予發(fā)送，如果總長超過120字節(jié)，則發(fā)送時(shí)標(biāo)題內(nèi)容將 被截取。5客戶端調(diào)用方法（mt發(fā)送短信）摘要：本章詳細(xì)介紹了如何使用客戶端組件捉交發(fā)

15、送短信請求采用java語言開發(fā)，支持目前主流的各種平臺(tái)，包括windows> unix> linux操作系統(tǒng) 實(shí)例程序參考dcmofmmc.java*短信平臺(tái)客八端編程實(shí)例*描述：*開發(fā)語言為java,該說明適用于java程序員*該實(shí)例適用于windows, linux,所有unix（可安裝jdk1.3以上版本和jce）操作系統(tǒng)，不 能用于手持設(shè)備。*注:如果使ju jdk1.4以上版本不需要額外安裝jce。如果使用jdk1.3x,請安裝jce。*該實(shí)例采用了 apache紐織的axis項(xiàng)目的庫完成soap協(xié)議over http功能，版本是 1rc2,*你也町以采用其他你所熟悉的s

16、oap兼容庫。* apache axis 的詳細(xì)介紹請參見 /axis/*通過ssl發(fā)送短信的實(shí)現(xiàn)參照該方式白行解決*該程序的邏輯說明請參見短信平臺(tái)客戶端開發(fā)的相關(guān)文檔*該程序只作為參考實(shí)現(xiàn)，未考慮運(yùn)行效率，請客戶端開發(fā)者根據(jù)自己的實(shí)際情況修改，*例如盡最減少網(wǎng)絡(luò)連接請求次數(shù)等* 版本：1.0.0*/ 使用步驟：（以下僅供參考）1）利用axis的wsdl2java工具生成java客戶端程序（建議使用axis 1_2以上版本） 命令行為：java -cp "<axis_jar_lib>" org.apache.axis.wsd

17、l.wsdl2java <your_wsdl_url> 例如：假設(shè) axis-l_2 裝在 e:programeilesjava-cp"e:programfilesaxis-l_2libaxis. jar;e:programfilesaxisl_2libaxisant. ja r;e:programfilesaxis-l 2libcommons-discovery. jar;e:programfilesaxisl 21 ibcommons logging. jar;e:programfilesaxis 1_21ibjaxrpc. jar;e:programfi1es ax

18、is-l_2liblog4j-l. 2. 8. jar;e:programfilesaxis-l_2libsaaj. jar;e:programfi lesaxis-l_2libwsdl4j-l. 5. 1. jar"org. apache, axis. wsdl. wsdl2javahttp:/127. 0. 0. 1:8080/axis/servicos/smsg?wsdl - p die nt （* -p后面為生成的java類的包名，用戶可根據(jù)需要白己定義）注意：127. 0.0. 1： 8080實(shí)際填寫是im機(jī)器的ip地址。2）在c根目錄卜牛成client文件夾，里面有jav

19、a客戶端代理程序smsg. java,smsgservice. java,smsgservicelocator. javasmsgsoapbindi ngstub. java3）將這幾個(gè)java類導(dǎo)入你的開發(fā)工程，4）如實(shí)例程序demoframe.java所示的進(jìn)行調(diào)用smsgservice service=new smsgservicelocator（）;smsg client二scrvicc.gctsmsg（）;string result=client.sendsm（apicodejoginname,loginpwd,mobiles,contentsmld）;5）切記要引入lib目錄卜-的

20、jar文件6接收mo和狀態(tài)報(bào)告的前置條件6. 1前置條件確保api用戶已經(jīng)創(chuàng)建webservice接口，api與上行相關(guān)的信息，有以下幾點(diǎn)：> 短信回執(zhí)目標(biāo)url ：此為您的上行接收邏輯的名稱，如 http:/iocalhost:8080/im/upreceiver.asp> mo目標(biāo) ul :此為您的上行接收邏輯的名稱，如 http:/localhost:8080/im/upreceiver.asp7接收mo上行短信摘要：本章詳細(xì)介紹了如何接收用戶手機(jī)的上行短信7. 1上行短信的xml定義<?xml version=h1.0n encoding=,utf-8,?>&l

21、t;im apicode=t ><sms><deliver mobile=quot; smjd=”1” content請假一天”/><deliver mobile=quot; smjd=t content請假 3 天”/a </sms></im>節(jié)點(diǎn)說明:節(jié)點(diǎn)描述apicode接口編號(hào)mobile發(fā)送短信的手機(jī)號(hào)碼sm idmo短信的短信idcontent短信內(nèi)容1) 移動(dòng)服務(wù)器端的上行組件將上行短信組織成xml,然后根據(jù)api調(diào)用程序所在地址主動(dòng) 提交給特定的jsp文件處理。2)

22、服務(wù)端每次最多只返回200個(gè)mo短信。7.2如何接收上行xml在此以java (jsp)為例：<% page contenttype=,'text/html; charset=gbk” %><html><head><title>jsp1</title></head><body bgcolor="#ffffff"><h1>begin</h1><%servletlnputstream sin = request.getlnputstream(); byte

23、buf = new byte51200;int index = 0;while (true) int ch = sin .read();if (ch =break;bufi ndex+ = (byte)ch;/out.printl n(ch); byte buf2 = new byteindex;system.arraycopy(buf, 0, buf2, 0, index);string info = new string(buf2, "gbk");out.pri ntln(i nfo);r將得到的字符串寫入xml文件byte buf3 = info.trim().get

24、bytes(ngbkh);string temp = new string(buf3, "iso8859-1")file f=new file("xiaogao1.xmr,);if(f.exists()f=new file("aa.xml");trydataoutputstream output = new dataoutputstream(new fileoutputstream(f); output.writebytes(temp);catch (exception e)/todo auto-generated catch block e.

25、printstacktrace();*/%><h1>end</h1></body></html>本節(jié)介紹了如何撰寫接收上行短信xml流的jsp文件(linux/unix)0其中就就jsp只是簡 單的將此xml流存成文件，企業(yè)可以根據(jù)口己的需婆做更多的事情。7. 3小結(jié)本章介紹了如何接收上行短信，可以將此理解為移動(dòng)服務(wù)器向企業(yè)客八端push（推） 的過程。8接收狀態(tài)報(bào)告接收狀態(tài)報(bào)告的過程和接收上行短信處理方法一致。8. 1狀態(tài)報(bào)告的xml定義<?xml version=n1.0n encoding=',utf-8m?><im apicode =”1”><