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

MAS效勞器WebServiceAPI接口用戶手冊嘉訊軟件2006-3修訂記錄ID修訂歷史修改人日期陳鐵鋼2006-4-1高樂平2006-12-12簡介本協(xié)議用于IM與通過API接入IM的客戶端的數(shù)據(jù)傳輸通訊?？s略語清單：client：所有通過WebService接口接入IM的客戶端 IM(InformationMachine)：信息機(jī),本文中特指短信API移動效勞端API原理WebServiceapi短信收發(fā)使用原理請參照IM產(chǎn)品發(fā)布時附帶的文件《IM移動信息機(jī)API2.0開發(fā)手冊》。本文檔不再重復(fù)闡述。本文檔解決的是WebServiceAPI使用方式說明。WebService接口API功能概述MT短信發(fā)送；MO短信接收；狀態(tài)報告接口；訪問smwebservice效勞地址WSDL：:///axis/services/SMsg?wsdl地址：/axis/services/SMsg注意：這里127.0.0.1只是例如，實(shí)指用戶IM機(jī)器的IP地址。在IE中任意輸入以上兩個url地址，如可以訪問到效勞〔沒有出現(xiàn)異?！?，那么表示smwebservice效勞已正常啟動，可以進(jìn)行以下開發(fā)創(chuàng)立smwebservice接口在web頁面中登陸信息機(jī)，進(jìn)入系統(tǒng)管理—接口管理新增頁面如以下圖選擇接口類型為webservice接口如果不需要回執(zhí)回執(zhí)要求一項(xiàng)選擇為不支持回執(zhí)短信回執(zhí)目標(biāo)url一項(xiàng)為客戶端被動接收回執(zhí)的URL，根據(jù)用戶自己需要填寫mo目標(biāo)url一項(xiàng)為客戶端被動接收MO的URL，根據(jù)用戶自己需要填寫接口說明如果不需要回執(zhí)和mo，短信回執(zhí)目標(biāo)url和mo目標(biāo)url可填空接口狀態(tài)選運(yùn)行狀態(tài)，否那么短信無法發(fā)送成功其他幾項(xiàng)用戶根據(jù)自己需要填寫WebService接口方法說明sendSM方法方法說明：發(fā)送一條MT短信到一個號碼/號碼集。publicStringsendSM(Stringapicode,StringloginName,StringloginPwd,Stringmobiles,Stringcontent,StringsmID)參數(shù)說明：參數(shù)描述apicode接口編碼(必填)loginName接口創(chuàng)立時的接口登錄名(必填)loginPwd接口創(chuàng)立時的接口登錄密碼(必填)mobiles短信發(fā)送的目的號碼。可以填寫多個，但必須以英文分號隔開(必填)如：“〞(必填)Content短信內(nèi)容，超過260個字符局部會被截斷(必填)smID短信ID，0到99999999中的某一整數(shù)。確保唯一后可以用來找到對應(yīng)的回執(zhí)、回復(fù)。缺省值0?！部蔀榭铡硈endWAPPUSHSM方法方法說明：發(fā)送一條MTWAPPUSH短信到一個號碼/號碼集。publicStringsendSM(Stringapicode,StringloginName,StringloginPwd,Stringmobiles,Stringtitle,Stringurl,StringsmID)參數(shù)說明：參數(shù)描述apicode接口編碼(必填)loginName接口創(chuàng)立時的接口登錄名(必填)loginPwd接口創(chuàng)立時的接口登錄密碼(必填)mobiles短信發(fā)送的目的號碼。可以填寫多個，但必須以英文分號隔開(必填)如：“〞(必填)title短信標(biāo)題。urlWAPPush短信的URL，為“〞或null時那么發(fā)送常規(guī)短信。(必填)smID短信ID，0到99999999中的某一整數(shù)。確保唯一后可以用來找到對應(yīng)的回執(zhí)、回復(fù)。缺省值0?！部蔀榭铡硈endSM方法方法說明：發(fā)送一條MT短信到一個號碼/號碼集。publicStringsendSM(Stringapicode,StringloginName,StringloginPwd,Stringmobiles,Stringcontent,longsmID)參數(shù)說明：參數(shù)描述apicode接口編碼(必填)loginName接口創(chuàng)立時的接口登錄名(必填)loginPwd接口創(chuàng)立時的接口登錄密碼(必填)mobiles短信發(fā)送的目的號碼?？梢蕴顚懚鄠€，但必須以英文分號隔開(必填)如：“〞(必填)Content短信內(nèi)容，超過260個字符局部會被截斷(必填)smID短信ID，0到99999999中的某一整數(shù)。確保唯一后可以用來找到對應(yīng)的回執(zhí)、回復(fù)(必填)sendSM方法方法說明：發(fā)送一條MT短信到一個號碼/號碼集。publicStringsendSM(Stringapicode,StringloginName,StringloginPwd,Stringmobiles,Stringcontent,longsmID，longsrcID)參數(shù)說明：參數(shù)描述apicode接口編碼(必填)loginName接口創(chuàng)立時的接口登錄名(必填)loginPwd接口創(chuàng)立時的接口登錄密碼(必填)mobiles短信發(fā)送的目的號碼?？梢蕴顚懚鄠€，但必須以英文分號隔開(必填)如：“〞(必填)Content短信內(nèi)容，超過260個字符局部會被截斷(必填)smID短信ID，0到99999999中的某一整數(shù)。確保唯一后可以用來找到對應(yīng)的回執(zhí)、回復(fù)。(必填)srcID終端源地址,缺省值為smID.(可為空)sendSM方法方法說明：發(fā)送一條MT短信到一個號碼/號碼集。publicStringsendSM(Stringapicode,StringloginName,StringloginPwd,Stringmobiles,Stringcontent,longsmID,Stringurl)參數(shù)說明：參數(shù)描述apicode接口編碼(必填)loginName接口創(chuàng)立時的接口登錄名(必填)loginPwd接口創(chuàng)立時的接口登錄密碼(必填)mobiles短信發(fā)送的目的號碼?？梢蕴顚懚鄠€，但必須以英文分號隔開(必填)如：“〞(必填)Content短信內(nèi)容，超過260個字符局部會被截斷(必填)smID短信ID，0到99999999中的某一整數(shù)。確保唯一后可以用來找到對應(yīng)的回執(zhí)、回復(fù)。(必填)urlWAPPush短信的URL，為“〞或null時那么發(fā)送常規(guī)短信。.(可為空)sendSM方法方法說明：發(fā)送一條MT短信到一個號碼/號碼集。publicStringsendSM(Stringapicode,StringloginName,StringloginPwd,Stringmobiles,Stringcontent,longsmID,longsrcID,Stringurl)參數(shù)說明：參數(shù)描述apicode接口編碼(必填)loginName接口創(chuàng)立時的接口登錄名(必填)loginPwd接口創(chuàng)立時的接口登錄密碼(必填)mobiles短信發(fā)送的目的號碼?？梢蕴顚懚鄠€，但必須以英文分號隔開(必填)如：“〞(必填)Content短信內(nèi)容，超過260個字符局部會被截斷(必填)smID短信ID，0到99999999中的某一整數(shù)。確保唯一后可以用來找到對應(yīng)的回執(zhí)、回復(fù)。(必填)srcID終端源地址,缺省值為smID.(可為空)urlWAPPush短信的URL，為“〞或null時那么發(fā)送常規(guī)短信。.(可為空)sendSM方法方法說明：發(fā)送一條MTWAPPUSH短信到一個號碼/號碼集。publicStringsendSM(Stringapicode,StringloginName,StringloginPwd,Stringmobiles,Stringcontent,StringsmID,StringsrcID,Stringurl)參數(shù)說明：參數(shù)描述apicode接口編碼(必填)loginName接口創(chuàng)立時的接口登錄名(必填)loginPwd接口創(chuàng)立時的接口登錄密碼(必填)mobiles短信發(fā)送的目的號碼。可以填寫多個，但必須以英文分號隔開(必填)如：“〞(必填)Content短信內(nèi)容，超過260個字符局部會被截斷(必填)。smID短信ID，0到99999999中的某一整數(shù)。確保唯一后可以用來找到對應(yīng)的回執(zhí)、回復(fù)。(必填)srcID終端源地址,缺省值為smID.(可為空)urlWAPPush短信的URL，為“〞或null時那么發(fā)送常規(guī)短信。.(可為空)注意：WAPPUSH短信URL不能大于110字節(jié)，url和內(nèi)容總長不能超過120字節(jié)。如果url超過110字節(jié)，那么IM接收后可能做異常處理不予發(fā)送，如果總長超過120字節(jié)，那么發(fā)送時標(biāo)題內(nèi)容將被截取?？蛻舳苏{(diào)用方法〔MT發(fā)送短信〕摘要：本章詳細(xì)介紹了如何使用客戶端組件提交發(fā)送短信請求采用Java語言開發(fā)，支持目前主流的各種平臺，包括Windows、Unix、Linux操作系統(tǒng)實(shí)例程序參考/***短信平臺客戶端編程實(shí)例**描述:*開發(fā)語言為JAVA，該說明適用于JAVA程序員*該實(shí)例適用于windows,Linux,所有UNIX(可安裝JDK1.3以上版本和JCE)操作系統(tǒng)，不能用于手持設(shè)備。*注:如果使用JDK1.4以上版本不需要額外安裝JCE。如果使用JDK1.3x，請安裝JCE。*該實(shí)例采用了Apache組織的axis工程的庫完成SOAP協(xié)議Over功能，版本是1.1RC2，*你也可以采用其他你所熟悉的SOAP兼容庫。*通過SSL發(fā)送短信的實(shí)現(xiàn)參照該方式自行解決*該程序的邏輯說明請參見短信平臺客戶端開發(fā)的相關(guān)文檔*該程序只作為參考實(shí)現(xiàn)，未考慮運(yùn)行效率，請客戶端開發(fā)者根據(jù)自己的實(shí)際情況修改，*例如盡量減少網(wǎng)絡(luò)連接請求次數(shù)等*版本:*/使用步驟:〔以下僅供參考〕利用axis的wsdl2java工具生成java客戶端程序〔建議使用axis1_2以上版本〕命令行為:java-cp"<axis_jar_lib>"org.apache.axis.wsdl.WSDL2Java<your_wsdl_url>例如：假設(shè)axis-1_2裝在E:\ProgramFilesjava-cp"E:\ProgramFiles\axis-1_2\lib\axis.jar;E:\ProgramFiles\axis-1_2\lib\axis-ant.jar;E:\ProgramFiles\axis-1_2\lib\commons-discovery.jar;E:\ProgramFiles\axis-1_2\lib\commons-logging.jar;E:\ProgramFiles\axis-1_2\lib\jaxrpc.jar;E:\ProgramFiles\axis-1_2\lib\log4j-1.2.8.jar;E:\ProgramFiles\axis-1_2\lib\saaj.jar;E:\ProgramFiles\axis-1_2\lib\"org.apache.axis.wsdl.WSDL2Java://:8080/axis/services/SMsg?wsdl–(*-p后面為生成的java類的包名，用戶可根據(jù)需要自己定義)：8080實(shí)際填寫是IM機(jī)器的IP地址。在c根目錄下生成client文件夾，里面有java客戶端代理程序，，將這幾個java類導(dǎo)入你的開發(fā)工程,如實(shí)例程序DemoFrame.java所示的進(jìn)行調(diào)用SMsgServiceservice=newSMsgServiceLocator();SMsgclient=service.getSMsg();Stringresult=client.sendSM(apiCode,loginName,loginPwd,mobiles,content,,smId);5〕切記要引入lib目錄下的jar文件接收MO和狀態(tài)報告的前置條件前置條件確保API用戶已經(jīng)創(chuàng)立webservice接口，API與上行相關(guān)的信息，有以下幾點(diǎn)：短信回執(zhí)目標(biāo)url：此為您的上行接收邏輯的名稱，如://localhost:8080/im/Mo目標(biāo)url接收MO上行短信摘要：本章詳細(xì)介紹了如何接收用戶的上行短信上行短信的XML定義<?xmlversion="1.0"encoding="UTF-8"?><imapicode="1"><sms><delivermobile=""sm_id="1"content="請假一天"/><delivermobile=""sm_id="1"content="請假3天"/></sms></im>節(jié)點(diǎn)說明：節(jié)點(diǎn)描述apicode接口編號mobile發(fā)送短信的號碼sm_idMO短信的短信IDcontent短信內(nèi)容1)移動效勞器端的上行組件將上行短信組織成XML，然后根據(jù)API調(diào)用程序所在地址主動提交給特定的jsp文件處理。2)效勞端每次最多只返回200個MO短信。如何接收上行XML在此以java〔jsp〕為例:<%@pagecontentType="text/html;charset=GBK"%><html><head><title>jsp1</title></head><bodybgcolor="#ffffff"><h1>begin</h1><%ServletInputStreamsin=request.getInputStream();byte[]buf=newbyte[51200];intindex=0;while(true){intch=sin.read();if(ch==-1)break;buf[index++]=(byte)ch;//out.println(ch);}byte[]buf2=newbyte[index];System.arraycopy(buf,0,buf2,0,index);Stringinfo=newString(buf2,"GBK");out.println(info);/**j將得到的字符串寫入xml文件byte[]buf3=info.trim().getBytes("GBK");Stringtemp=newString(buf3,"iso8859-1")Filef=newFile("xiaogao1.xml");if(f.exists()){f=newFile("aa.xml"); } try {DataOutputStreamoutput=newDataOutputStream(newFileOutputStream(f));output.writeBytes(temp); } catch(Exceptione) { //TODOAuto-generatedcatchblock e.printStackTrace(); }**/%><h1>end</h1></body></html>本節(jié)介紹了如何撰寫接收上行短信XML流的jsp文件(linux/unix)。其中就就jsp只是簡單的將此XML流存成文件，企業(yè)可以根據(jù)自己的需要做更多的事情。小結(jié)本章介紹了如何接收上行短信，可以將此理解為移動效勞器向企業(yè)客戶端PUSH(推)的過程。接收狀態(tài)報告接收狀態(tài)報告的過程和接收上行短信處理方法一致。狀態(tài)報告的XML定義<?xmlversion="1.0"encoding="UTF-8"?><imapicode="1"><sms>