infoX-MASAPI接口说明(JAVA).docx

1总体说明1-11.1 JAVA接口概述1-21.2 读若范围1-21.3 相关约定1-22API说明2-12.1 API概逑2-22.2 根本数器类型介绍2-32.3 数据结构详细描述2-32.4 接口介貂2-71. 4.1DBSMProxy2-72. 4.2initConn2-73. 4.3initConn2-84. 4.4initConn2-85. 4.5sendSn2-86. 4.6SendMu1.tiSn2-97. 4.7getReceivcdSms2-108. 4.8query,SmsResu1.t2-119. 4.91.ogin2-1210. 4.10isConnected21211. 4.111.ogout2-1212. 4.12destroy2-133安装使用指导3-1413. I介绍安装JAVASMSAPI3-113.2 入开发库3-113.3 法诃用3-14例如代码4-114. 1树的化迷接对策并登录4-214.2 送短信4-214.3 询短信发送情况4-314.4 谢疸信接收情况4-414.5 毁迷接或者退出登荥4-55配文件说明5-115. Ipiconf.xn1.5-2表2TJavaAPI的炮信接口2-2表2-2根本数据类型简介2-3表2-3SmReceiveBean字段说明2-3表2-4SmSendBoan字段说明2-4表2-5SmSendResu1.tBean字段说明2-6关于本章总体说明标题内容1.1JAVA311ft介绍JAYA接口的背景知识.1.2读者范国介招水手册的读者对象.1.3相关约定介绍本手册的相关约定.本章描逑内容如下表所示.1.1 JAVA接口概述为了企业用户更加简便、灵活地实现相关的业务,企业业务系统可以接入W1.S(Mobi1.eARentServer)的应用开发接口.MAS以JAYA的方式并装具短信接口，提供应企业应用系统调用。该JAYA组件封装的对象可以提供短信单发接口.数据摩初始化接口、用户登录初始化接口.短信接收接口.速信查询接口.其中短信资询接口用于查询巳姓发送的短信的情况.该版本不提供短信群发接口和点点通短信接口1.2 读者范围本手册适用于华为公司MAS开发人员,企业IT管理、维护部门的相关开发人员。1.3 相关约定在本文中每个AP1.(RPP1.iCa1.iOnPrOgramningInterface)函数的描述由四局部组成：杀数功能、函数原型、卷数说明和返回码/值。函数功能描述RP1.的主要功能。函数原型描逑API原型，可直接拷贝程序中的函数原型代码.参数说明 名称：参数名称 如何理解：对叁数的简单解择 备注：箝入/输出参数的相关信息返回码/值AP1.调用过程中的返回码/值，分为成功曲的返回和舁常返回.如果是异禽返回，分别对每一个可能的异常迸行详组插述，包括异常名冰及相应说明，关于本章AP1.说明标账内容2.1APItt介绍JAVA通信AP1.的根本组成。2.2根本数据类型介绍各类数据结再介绍。本章描逑内容如下表所示。2.1 API概述本文档定义了开发程序和MAS之间的所有短信API.如表2T所示。表2-1JaVaAPI的短信接口序号接口名称描逑1pub1.icDBSMProxy()窿立一个和MAS短信接D访问的代理对然”2pub1.icfina1.voidinitConn()throwsException初始化和MAS系统的堆接.3pub1.icfina1.voidinitConn(StringCOnfFiIe)throwsException初给化和联S系统的连接.1pub1.icfina1.voidinitConn(Mapargs)throwsException初始化和MAS系统的连接.5pub1.icfina1.intScndSm(SmScndBcanSCndBean)throwsException发送通消息接口消息。6intsendMuItiSm(S®Sendfk?ansendBean)发送短消息棱口，提交一条群发消息到MAS的发送消息队列。rRctRcccivcdSms(intBaxCount.java,uti1.DatefromTi三e.java.uti1.DateendTime,java.1.ang.Stringorgddr,java.Iang.StringdestAddr)throwsjava.1.ang.Exception从MAS接收的消息队列中获取消息。8pub1.icfina1.SmSendResu1tBeanquery11sResu1.t(intsm_id,java.uti1.Datef<11Tiu.java.uti1.DateendTime,StringOrgAddr.StringdestAddr)throwsException受询妲消息发送结果.9pub1.icfina1.void1.ogin(StringuserNaaevStringpassword)IhroWSException根据用户名、密码登录系统，登录MAS,如果失败他出异常。10boo1.eanisConnected()判斯API是否巳经和MAS建交了连接.Hpub1.icfina1.void1.ogout()退出登录函数仅仅清理当前的用户，可以在比基袖上事次登录,连接仍然是存在的。12pub1.icfina1.voiddestroy()销毁函数，将清理连接，关停数据库连接，2.2 根本数据类型介绍短信RP1.中各种根本数密类型表示如下.表22根本数据类型自介名称如何理第SmSendBean短信发送的消息结构体，SmReceivcBean接收消息的结构体指逑。SmSendResuItBean发送结果的消息体拓逑.23数据结构详细描述SmReceiveBean接收消息的转构体描逑.从MS中获取消息，获取完成之后自动在Ib1.Sn1.reCeiVed表中把Reserve1字段配置为1.结为体各字段的说明请叁见表2-3.SniRcceivcBean继承于SIrtSCndBeanO表2-3SrrKeceiveBean字段说明字段名字段类型字段说明SmActionJDprivatejava.1.ang.String接收消息的请求类型。CMPP(ChinaMobi1.ePeertoreer)3消息点将使用.参见CMPP3协议。SMPP(ShortMessagePeertoPeer)不使用。smActionReasonIDprivatejava.1.ong.String接收消息的请求原因.CMPP3消息点播便用.SMPP不使用.SinDestAddrprivateJava.1.ang.String接收消息的目的地址,对应的就是SP的接入号.sm1.dprivateint接收消息id唯一标识），-1.的时候说明此消息为无效消息。SmMessage1.Dprivatejava.IanR.Siring接收消息的类型。CMPP3消息点播使用。SMpP不使用。StnMsgContentprivatejava.1.ang.String接收消息的消息内容.SmOrgAddrprivatejava.1.a11R.String接收消息的源地址,对应于发送方手机号码.字段名字段类型字段说明SmOrgAddrTypeprivateint接收消息的源地址类型,包括落种类型：施码宾宾手机号码CMPP3消息点播使用。SMPP不便用。smRecvTicprivatejava.uti1.Date接收消息的接收时间。SmReserve1privatejava.1.ang.String接收消息的保存标识，管时没有使用。S1.nReSCrVC2privatejava.1.ang.String接收消息的保存标识.哲时没有使用。SmServiceIDprivatejava.1.ang.String接收消息的请求业务id.CMPP3消息点势使用.SMPP不使用。SmTypeprivateint接收消息的类型。CMPp3消息点播使用.SMPP不使用.SmSendBcanSmSendBean是短信发送的消息结构体。在这个结构体中,必受域写的字段只有目的地址和消息内容,其他字段使用文件或者AP1.中的缺古值.如果缺皆值不对.将导致无法调用,调用者需要囱己在调用AP1.初始化的时候，指定API属性配置文件，或者在程序中设定非必填字段。结构体各字段的说明请参见表2-4.表24SnSendBean字段电明字段名字段类型字段说明priorityprotectt?dinx优先级别,对应于sdb的Send1.eve1.sendSMIDprotcc1.edint返国发送到MAS的Smid,唯一标识发送短佶的ID.SendTypeprotectedint发送类型.0：SMSEND_TYPE_TE)CT,普通文本消息5：SMSENDTYPE,消息Rktf1.：0SnDestAddrsprotectedjava.1.ang.String目的手机号码。填写接收该条就信的手机号码。可以为任意多个.RPI函数囱动拆分成多会短信发送.该字段为必填字段，sm1.>esXAddrTypeprotectedint目的地址类型。CMPP3消息点播使用.SMPP不使用.字段名字段类型字段说明SinFeeCodeprotectedjava.1.ang.String配合SmFeeType,用来标识计费多少费用O在Q1.PP协议中，单位为分.在Bf1.外，雷要根据当地的怖议规定填写。SmFccTypeprotectedjava.1.ang.String计费类型，标识包月、封顶、单条、免费、不计费等.根据当地协双规定. CMPP：请参考CMPP怖议填写。 SMPP：无意义。StnMessageIDprotectedjava.1.ang.StringCMPP3点矮使用,SMPP无须填芍.SmMsgContentprotectedjava.1.ang.String短消息内容。此字段为必殖字段。Sn1.MSg1.Dprotectedjava.1.ang.String用作第三方计费使用，SMPP等协议暂时不使用.SinNeedStateReportp<tf.(ii11t该条消息是否需要状态报自，SmOrgAddrprotectedjava.1.ang.String消息的源地址.如果是SP业务，则是对应的SP接入号.SmReserve1.：'1.Htrt.dint