MAS应用服务器webservice接口用户手册

MAS效劳器WebServiceAPI接口用户手册嘉讯软件2006-3修订记录ID修订历史修改人日期陈铁钢2006-4-1高乐平2006-12-12简介本协议用于IM与通过API接入IM的客户端的数据传输通讯。缩略语清单：client：所有通过WebService接口接入IM的客户端 IM(InformationMachine)：信息机,本文中特指短信API移动效劳端API原理WebServiceapi短信收发使用原理请参照IM产品发布时附带的文件《IM移动信息机API2.0开发手册》。本文档不再重复阐述。本文档解决的是WebServiceAPI使用方式说明。WebService接口API功能概述MT短信发送；MO短信接收；状态报告接口；访问smwebservice效劳地址WSDL：:///axis/services/SMsg?wsdl地址：/axis/services/SMsg注意：这里127.0.0.1只是例如，实指用户IM机器的IP地址。在IE中任意输入以上两个url地址，如可以访问到效劳〔没有出现异常〕，那么表示smwebservice效劳已正常启动，可以进行以下开发创立smwebservice接口在web页面中登陆信息机，进入系统管理—接口管理新增页面如以下图选择接口类型为webservice接口如果不需要回执回执要求一项选择为不支持回执短信回执目标url一项为客户端被动接收回执的URL，根据用户自己需要填写mo目标url一项为客户端被动接收MO的URL，根据用户自己需要填写接口说明如果不需要回执和mo，短信回执目标url和mo目标url可填空接口状态选运行状态，否那么短信无法发送成功其他几项用户根据自己需要填写WebService接口方法说明sendSM方法方法说明：发送一条MT短信到一个号码/号码集。publicStringsendSM(Stringapicode,StringloginName,StringloginPwd,Stringmobiles,Stringcontent,StringsmID)参数说明：参数描述apicode接口编码(必填)loginName接口创立时的接口登录名(必填)loginPwd接口创立时的接口登录密码(必填)mobiles短信发送的目的号码。可以填写多个，但必须以英文分号隔开(必填)如：“〞(必填)Content短信内容，超过260个字符局部会被截断(必填)smID短信ID，0到99999999中的某一整数。确保唯一后可以用来找到对应的回执、回复。缺省值0。〔可为空〕sendWAPPUSHSM方法方法说明：发送一条MTWAPPUSH短信到一个号码/号码集。publicStringsendSM(Stringapicode,StringloginName,StringloginPwd,Stringmobiles,Stringtitle,Stringurl,StringsmID)参数说明：参数描述apicode接口编码(必填)loginName接口创立时的接口登录名(必填)loginPwd接口创立时的接口登录密码(必填)mobiles短信发送的目的号码。可以填写多个，但必须以英文分号隔开(必填)如：“〞(必填)title短信标题。urlWAPPush短信的URL，为“〞或null时那么发送常规短信。(必填)smID短信ID，0到99999999中的某一整数。确保唯一后可以用来找到对应的回执、回复。缺省值0。〔可为空〕sendSM方法方法说明：发送一条MT短信到一个号码/号码集。publicStringsendSM(Stringapicode,StringloginName,StringloginPwd,Stringmobiles,Stringcontent,longsmID)参数说明：参数描述apicode接口编码(必填)loginName接口创立时的接口登录名(必填)loginPwd接口创立时的接口登录密码(必填)mobiles短信发送的目的号码。可以填写多个，但必须以英文分号隔开(必填)如：“〞(必填)Content短信内容，超过260个字符局部会被截断(必填)smID短信ID，0到99999999中的某一整数。确保唯一后可以用来找到对应的回执、回复(必填)sendSM方法方法说明：发送一条MT短信到一个号码/号码集。publicStringsendSM(Stringapicode,StringloginName,StringloginPwd,Stringmobiles,Stringcontent,longsmID，longsrcID)参数说明：参数描述apicode接口编码(必填)loginName接口创立时的接口登录名(必填)loginPwd接口创立时的接口登录密码(必填)mobiles短信发送的目的号码。可以填写多个，但必须以英文分号隔开(必填)如：“〞(必填)Content短信内容，超过260个字符局部会被截断(必填)smID短信ID，0到99999999中的某一整数。确保唯一后可以用来找到对应的回执、回复。(必填)srcID终端源地址,缺省值为smID.(可为空)sendSM方法方法说明：发送一条MT短信到一个号码/号码集。publicStringsendSM(Stringapicode,StringloginName,StringloginPwd,Stringmobiles,Stringcontent,longsmID,Stringurl)参数说明：参数描述apicode接口编码(必填)loginName接口创立时的接口登录名(必填)loginPwd接口创立时的接口登录密码(必填)mobiles短信发送的目的号码。可以填写多个，但必须以英文分号隔开(必填)如：“〞(必填)Content短信内容，超过260个字符局部会被截断(必填)smID短信ID，0到99999999中的某一整数。确保唯一后可以用来找到对应的回执、回复。(必填)urlWAPPush短信的URL，为“〞或null时那么发送常规短信。.(可为空)sendSM方法方法说明：发送一条MT短信到一个号码/号码集。publicStringsendSM(Stringapicode,StringloginName,StringloginPwd,Stringmobiles,Stringcontent,longsmID,longsrcID,Stringurl)参数说明：参数描述apicode接口编码(必填)loginName接口创立时的接口登录名(必填)loginPwd接口创立时的接口登录密码(必填)mobiles短信发送的目的号码。可以填写多个，但必须以英文分号隔开(必填)如：“〞(必填)Content短信内容，超过260个字符局部会被截断(必填)smID短信ID，0到99999999中的某一整数。确保唯一后可以用来找到对应的回执、回复。(必填)srcID终端源地址,缺省值为smID.(可为空)urlWAPPush短信的URL，为“〞或null时那么发送常规短信。.(可为空)sendSM方法方法说明：发送一条MTWAPPUSH短信到一个号码/号码集。publicStringsendSM(Stringapicode,StringloginName,StringloginPwd,Stringmobiles,Stringcontent,StringsmID,StringsrcID,Stringurl)参数说明：参数描述apicode接口编码(必填)loginName接口创立时的接口登录名(必填)loginPwd接口创立时的接口登录密码(必填)mobiles短信发送的目的号码。可以填写多个，但必须以英文分号隔开(必填)如：“〞(必填)Content短信内容，超过260个字符局部会被截断(必填)。smID短信ID，0到99999999中的某一整数。确保唯一后可以用来找到对应的回执、回复。(必填)srcID终端源地址,缺省值为smID.(可为空)urlWAPPush短信的URL，为“〞或null时那么发送常规短信。.(可为空)注意：WAPPUSH短信URL不能大于110字节，url和内容总长不能超过120字节。如果url超过110字节，那么IM接收后可能做异常处理不予发送，如果总长超过120字节，那么发送时标题内容将被截取。客户端调用方法〔MT发送短信〕摘要：本章详细介绍了如何使用客户端组件提交发送短信请求采用Java语言开发，支持目前主流的各种平台，包括Windows、Unix、Linux操作系统实例程序参考/***短信平台客户端编程实例**描述:*开发语言为JAVA，该说明适用于JAVA程序员*该实例适用于windows,Linux,所有UNIX(可安装JDK1.3以上版本和JCE)操作系统，不能用于手持设备。*注:如果使用JDK1.4以上版本不需要额外安装JCE。如果使用JDK1.3x，请安装JCE。*该实例采用了Apache组织的axis工程的库完成SOAP协议Over功能，版本是1.1RC2，*你也可以采用其他你所熟悉的SOAP兼容库。*通过SSL发送短信的实现参照该方式自行解决*该程序的逻辑说明请参见短信平台客户端开发的相关文档*该程序只作为参考实现，未考虑运行效率，请客户端开发者根据自己的实际情况修改，*例如尽量减少网络连接请求次数等*版本:*/使用步骤:〔以下仅供参考〕利用axis的wsdl2java工具生成java客户端程序〔建议使用axis1_2以上版本〕命令行为:java-cp"<axis_jar_lib>"org.apache.axis.wsdl.WSDL2Java<your_wsdl_url>例如：假设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类的包名，用户可根据需要自己定义)：8080实际填写是IM机器的IP地址。在c根目录下生成client文件夹，里面有java客户端代理程序，，将这几个java类导入你的开发工程,如实例程序DemoFrame.java所示的进行调用SMsgServiceservice=newSMsgServiceLocator();SMsgclient=service.getSMsg();Stringresult=client.sendSM(apiCode,loginName,loginPwd,mobiles,content,,smId);5〕切记要引入lib目录下的jar文件接收MO和状态报告的前置条件前置条件确保API用户已经创立webservice接口，API与上行相关的信息，有以下几点：短信回执目标url：此为您的上行接收逻辑的名称，如://localhost:8080/im/Mo目标url接收MO上行短信摘要：本章详细介绍了如何接收用户的上行短信上行短信的XML定义<?xmlversion="1.0"encoding="UTF-8"?><imapicode="1"><sms><delivermobile=""sm_id="1"content="请假一天"/><delivermobile=""sm_id="1"content="请假3天"/></sms></im>节点说明：节点描述apicode接口编号mobile发送短信的号码sm_idMO短信的短信IDcontent短信内容1)移动效劳器端的上行组件将上行短信组织成XML，然后根据API调用程序所在地址主动提交给特定的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>本节介绍了如何撰写接收上行短信XML流的jsp文件(linux/unix)。其中就就jsp只是简单的将此XML流存成文件，企业可以根据自己的需要做更多的事情。小结本章介绍了如何接收上行短信，可以将此理解为移动效劳器向企业客户端PUSH(推)的过程。接收状态报告接收状态报告的过程和接收上行短信处理方法一致。状态报告的XML定义<?xmlversion="1.0"encoding="UTF-8"?><imapicode="1"><sms>