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

1、mas 服务器 web service api 接 口用户手册v1.0嘉讯软件2006-3修订记录id修订历史修改人日期初稿v1.0陈铁钢2006-4-1修改稿vi.1高乐平2006-12-121简介木协议用于im与通过api接入im的客户端的数据传输通讯。缩略语清单：client：所有通过web service接口接入im的客户端lm(information machine)：信息机，本文中特指短信api移动服务端1.1 api原理web service api短信收发使用原理请参照im产品发布时附带的文件im移动信息机 api2.0开发手册。本文档不再重复阐述。本文档解决的是web ser

2、vice api使用方式说明。1. 2 web service 接口 api 功能概述1)mt m信发送；2)mo短信接收;3)状态报告接口;2访问sm webservice服务地址wsdl： http:/127. 0. 0. 1/axis/services/smsg?wsdl地址:http:/127. 0. 0. 1/axis/services/smsg注意：这里127. 0. 0.1只是示例，实指用户im机器的ip地址。在1e中任意输入以上两个url地址，如可以访问到服务(没有出现界常)，则表示sm wcbservice服务已正常启动，可以进行以下开发3 创建 sm webservice

3、接口在web页面屮登陆信息机，进入系统管理一接i i管理新增页血如下图新増接口接口編码：smapi接口名称：smapi接口类型：db接口 api接口q web service接口socket接口短信子码：手机指令：sm回执要求：支持回执e不支持回执登录用戶：smapi登录密码：接口状态：运行状态a调试状态短信回执目标url :http :/:8080/test1. jspm泪标url :http 7/:8080/test2 .jsp保存返回1. 选择接口类型为web service接口2. 如果不需要回执回执要求一项选择为不支持回执3. 短信|”|执目标ur

4、l 一项为容户端被动接收回执的url,根据用户白己需要填写4. m（）h标url 一项为客户端被动接收mo的url,根据用户自己需耍填写接口说明5. 如果不需要回执和mo,短信回执目标url和mo目标url可填空6. 接口状态选运行状态,否则短信无法发送成功7. 其他几项用户根据自己需要填写4 web service接口方法说明4. 1 sendsm 方法方法说明：发送一条mt短信到一个手机号码/手机号码集。public string sendsm(string apicode,string loginnaine,string loginpwd,string mobiles,string co

5、ntent,string smtd)参数说明:参数描述apicode接口编码（必填）loginname接口创建时的接口登录名（必填）loginpwd接口创建时的接口登录密码（必填）mobiles短信发送的目的于机号码。可以填写多个，但必须以 英文分号隔开（必填）如: （必填）content短信内容，超过260个字符部分会被截断（必填）smid短信id, 0到99999999中的某一整数。确保唯一后可 以用来找到对应的1叫执、冋复。缺省值0。（可为空）4. 2 sendwappushsm 方法方法说明：发送一条mt wappush短信到一个手机

6、号码/手机号码集。public string sendsm(string apicodc,参数说明：string loginname,string loginpwd,string mobiles,string title,string url,string smid)参数描述apicode接口编码（必填）loginname接口创建时的接口登录名（必填）loginpwd接口创建时的接口登录密码（必填）mobiles短信发送的目的于机号码。可以填写多个，但必须以 英文分号隔开（必填）如: （必填）title短信标题。urlwap push短信的u

7、rl,为“”或null时则发送常规 短信。（必填）smid短信id, 0到99999999中的某一整数。确保唯一后可 以用來找到对应的冋执、回复。缺省值0。（可为空）4. 3 sendsm 方法方法说明：发送一条mt短信到一个于机号码/手机号码集。public string sendsm（string apicode,参数说明：string loginname, string loginpwd, string mobiles, string content, long smtd)参数描述apicode接口编码（必填）loginname接口创建时的接口背录名（必填）loginpwd接口创建时的接

8、口登录密码（必填）mobiles矩信发送的冃的手机号码。町以填写多个，但必须以 英文分号隔开（必填）如： （必填）content短信内容，超过260个字符部分会被截断（必填）smid矩信id, 0到99999999中的某一整数。确保唯一后可 以用来找到对应的1叫执、回复（必填）4. 4 sendsm 方法方法说明：发送一条mt短信到一个手机号码/手机号码集。public string sendsm（string apicode,参数说明：string loginname, string loginpwd,string mobiles, str

9、ing content, long smid, long srcid)apicode接口编码（必填）loginname接口创建时的接口登录名（必填）loginpwd接口创建时的接口登录密码（必填）mobiles短信发送的口的手机号码。可以填写多个，但必须以英 文分号隔开（必填）如: 1350000000 lw （必填）content短信内容，超过260个字符部分会被截断（必填）smid短信id, 0到99999999中的某一整数。确保唯一后可 以用来找到对应的回执、回复。（必填）srcid终端源地址，缺省值为smid.（可为空）4. 5 sendsm 方法方法说明：发

10、送一条mt短信到一个于机号码/手机号码集。public string sendsm(string apicode,string loginname,string loginpwd,string mobiles,string content, long smid,string url) 参数说明：参数描述apicode接口编码（必填）loginname接口创建时的接口登录名（必填）loginpwd接口创建吋的接口登录密码（必填）mobiles短信发送的目的手机号码。可以填写多个，但必须以 英文分号隔开（必填）如： （必填）content短信内容

11、，超过260个字符部分会被截断（必填）smid短信id, 0到99999999中的某一整数。确保唯一后可 以用来找到对应的冋执、回复。（必填）urlwap push短信的url,为“”或null时则发送常规 短信。.（可为空）4. 6 sendsm 方法方法说明：发送一条mt短信到一个手机号码/手机号码集。public string sendsm（string apicode,参数说明：string loginname,string loginpwd,string mobiles,string content, long smld, long srcld,string url)参数描述apic

12、ode接口编码（必填）loginname接口创建时的接口登录名（必填）loginpwd接口创建吋的接口登录密码（必填）mobiles短信发送的11的手机号码。可以填写多个，但必须以 英文分号隔开（必填）如： （必填）content短信内容，超过260个字符部分会被截断（必填）smid矩信id, 0到99999999中的某一整数。确保唯一后可 以用來找到对应的回执、回复。（必填）srcid终端源地址，缺省值为smid.（可为空）urlwap push短信的url,为“”或null时则发送常规 短信。（可为空）4. 7 sendsm 方法方法说明

13、：发送一条mt wappush短信到一个手机号码/手机号码集。 public string sendsm(string apicode,string loginname,string loginpwd,string mobiles,string content,string smld,string srcld,string url参数说明:参数描述apicode接口编码（必填）loginname接u创建时的接u登录名（必填）loginpwd接口创建时的接口登录密码（必填）mobiles矩信发送的h的手机号码。对以填写多个，但必须以 英文分号隔开（必填）如： 13500

14、000001” （必填）content短信内容，超过260个字符部分会被截断（必填）。smid短信id, 0到99999999中的某一整数。确保唯一后可 以用来找到对应的回执、回复。（必填）srcid终端源地址，缺省值为smid.（可为空）urlwap push短信的url,为“”或null吋则发送常规 短信。（可为空）注意：wap push短信url不能大于110字节，url和内容总长不能超过120字节。如果ml超过110 字节，则im接收后可能做异常处理不予发送，如果总长超过120字节，则发送时标题内容将 被截取。5客户端调用方法（mt发送短信）摘要：本章详细介绍了如何使用客户端组件捉交发

15、送短信请求采用java语言开发，支持目前主流的各种平台，包括windows> unix> linux操作系统 实例程序参考dcmofmmc.java*短信平台客八端编程实例*描述：*开发语言为java,该说明适用于java程序员*该实例适用于windows, linux,所有unix（可安装jdk1.3以上版本和jce）操作系统，不 能用于手持设备。*注:如果使ju jdk1.4以上版本不需要额外安装jce。如果使用jdk1.3x,请安装jce。*该实例采用了 apache纽织的axis项目的库完成soap协议over http功能，版本是 1rc2,*你也町以采用其他你所熟悉的s

16、oap兼容库。* apache axis 的详细介绍请参见 /axis/*通过ssl发送短信的实现参照该方式白行解决*该程序的逻辑说明请参见短信平台客户端开发的相关文档*该程序只作为参考实现，未考虑运行效率，请客户端开发者根据自己的实际情况修改，*例如尽最减少网络连接请求次数等* 版本：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> 例如：假设 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类的包名，用户可根据需要白己定义）注意：127. 0.0. 1： 8080实际填写是im机器的ip地址。2）在c根目录卜牛成client文件夹，里面有jav

19、a客户端代理程序smsg. java,smsgservice. java,smsgservicelocator. javasmsgsoapbindi ngstub. java3）将这几个java类导入你的开发工程，4）如实例程序demoframe.java所示的进行调用smsgservice service=new smsgservicelocator（）;smsg client二scrvicc.gctsmsg（）;string result=client.sendsm（apicodejoginname,loginpwd,mobiles,contentsmld）;5）切记要引入lib目录卜-的

20、jar文件6接收mo和状态报告的前置条件6. 1前置条件确保api用户已经创建webservice接口，api与上行相关的信息，有以下几点：> 短信回执目标url ：此为您的上行接收逻辑的名称，如 http:/iocalhost:8080/im/upreceiver.asp> mo目标 ul :此为您的上行接收逻辑的名称，如 http:/localhost:8080/im/upreceiver.asp7接收mo上行短信摘要：本章详细介绍了如何接收用户手机的上行短信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>节点说明:节点描述apicode接口编号mobile发送短信的手机号码sm idmo短信的短信idcontent短信内容1) 移动服务器端的上行组件将上行短信组织成xml,然后根据api调用程序所在地址主动 提交给特定的jsp文件处理。2)

22、服务端每次最多只返回200个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>本节介绍了如何撰写接收上行短信xml流的jsp文件(linux/unix)0其中就就jsp只是简 单的将此xml流存成文件，企业可以根据口己的需婆做更多的事情。7. 3小结本章介绍了如何接收上行短信，可以将此理解为移动服务器向企业客八端push（推） 的过程。8接收状态报告接收状态报告的过程和接收上行短信处理方法一致。8. 1状态报告的xml定义<?xml version=n1.0n encoding=',utf-8m?><im apicode =”1”><