浙江融创OpenMAS移动代理服务器软件产品-基础组件接口设计文档

中国移动浙江公司OpenMAS移动代理效劳器软件产品v1.022/232023.06名目\l“_TOC_250008“概述 3\l“_TOC_250007“文档概述 3\l“_TOC_250006“引用标准 3\l“_TOC_250005“OpenMAS业务简介 4\l“_TOC_250004“OpenMAS业务定义 4\l“_TOC_250003“OpenMAS业务特征 4\l“_TOC_250002“接口说明 5短消息接口 5\l“_TOC_250001“业务功能 5流程说明 9数据类型定义 错误！未定义书签。短信发送(SendSMS)接口 错误！未定义书签。短信接收(GetSms)接口 错误！未定义书签。彩信接口 14\l“_TOC_250000“业务功能 14流程说明 17彩信表示标准 14数据类型定义 错误！未定义书签。彩信发送(SendMMS)接口 错误！未定义书签。彩信接收(GetReceivedMms)接口 错误！未定义书签。概述文档概述本文档描述了OpenMAS组件与SI/EC平台交互的接口，包括短信、彩信引用标准中国移动通信集团公司《省BOSS与业务治理平台〔业务平台〕接口标准〔暂行》〔V1.1.0〕中国移动通信集团公司《全网行业应用业务标准》中国移动通信集团公司《中国移动一级BOSS系统接口标准-全网行业应用-SMS业务单行本-IAGW-M2.0.0》中国移动通信集团公司《中国移动一级BOSS系统接口标准V1.4.5》中国移动通信集团公司《省行业网关开发全网行业应用总体技术要求－》[6]中国移动通信集团公司《省BOSS1.1.2》OpenMAS业务简介OpenMAS业务定义OpenMAS，即OpenMobileAgentServer，其将行业客户的各类应用与移动通信业务应SM〔ShortMessageServicUSSUnstructuredSupplementaryServiceData〕、MMS〔MultimediaMessagingService〕、WAP〔WirelessApplicationProtocol〕、KJava〔KiloJAVA〕IT应用环境与移动网络之间的桥动应用的的应用系统，丰富集团客户应用；对集成集团客户已有系统，OPENMAS系统可以OPENMAS系统开发针对性的移动应用。OpenMAS业务特征与OPENMAS效劳器所具备的特别地位对应，可以将OPENMAS效劳器的应用分为三个层次。作为集团客户应用系统的统一移动接入手段：为集团客户应用系统供给包括短信、彩信、USSD、WAP、WEB、定位等在内的统一通信力量。功能的侧重点是供给通信力量的支持。在这个层次，MAS作为统一移动接入力量供给者，不参与业务的核心逻辑；IT实现移动化的集团客户应用MAS效劳器也成为集团客户应用系统不行或缺的局部。为了实现移动化的需求，集团客户应用系统不需要进展大的改动，在MAS效劳器上需对集团客户应用系统的功能进展必要的扩大，MAS效劳器成为集团客户应用系统的延长。MASMAS效劳器供给的应用相对应用系统的范畴，并与其它集团客户应用系统共同使用MAS效劳器所供给的接入和移动化支撑功能。接口说明WebService接口业务功能集团客户应用系统通过此接口实现短信的收发和状态查询。集团客户应用系统调用SendMessage接口发送短信，OpenMAS接收恳求进展发送。在提交短信发送恳求之后，OpenMAS依据集团客户预先注册的插件主动通知短信发送状态。66/23 短信发送接口流程说明发送接口描述：集团客户应用系统在OpenMAS根底组件上注册〔并登记状态报告的接收UR，并在OpenMAS根底组件上生成账号；集团客户应用系统调用OpenMAS根底组件的sendMessageOpenMAS接收到短信，然后将短信发送到短信网关；OpenMAS接收短信网关的状态报告〔结果回执；OpenMAS依据注册的URLNotifySmsDeliveryReport〔带上回执的结果参数。集团客户应用系统猎取到具体的状态报告信息。77/23调用方式接口接口接口定义发起方落地方说明发送短信SendMessage应用系统OpenMAS应用系统必需通知发送状态NotifySmsDeliveryStatusOpenMAS应用系统提前注册对应插件发送方法(SendMessage)发起方：应用系统落地方：OpenMas平台stringSendMessage(stringApplicationID,stringPassword,string[]DestinationAddresses,stringMessage);stringSendMessage(stringApplicationID,stringPassword,string[]DestinationAddresses,stringMessagestringExtendCode);备注：MessageUTF-8恳求参数定义ApplicationIDID〔类型：string〕2、Password：应用程序发送短信密码，用来防止有人恶意仿照顾用程序发送短信〔类型：string〕3DestinationAddresses：短信接收方号码，可同时发多人〔类型：string〕4ExtendCode：由该应用填写的应用内部扩展号码。〔类型：string〕Message：短信内容〔类型：string〕返回值定义6、返回此次发送信息的唯一标识符，用于用户查询发送状态。(类型：string)状态报告方法(NotifySmsDeliveryReport)发起方：OpenMas平台落地方：应用系统限制条件：应用系统必需注册指定插件voidNotifySmsDeliveryReport(DeliveryReportdeliveryReport);恳求参数定义deliveryReport：短信发送状态，与发送恳求数组一一对应〔类型：DeliveryReport〕0Delivered发送成功。1WaitingForDelivery等待发送。2WaitingForDeliveryStatus已发送,等待状态报告。0Delivered发送成功。1WaitingForDelivery等待发送。2WaitingForDeliveryStatus已发送,等待状态报告。3DeliveryFailed发送失败。2ReceivedAddress：接收方地址〔string〕3、StatusCode：状态码，假设发送失败可确定错误缘由〔string〕4SendAddress：发送地址5MessageId：发送标识返回值定义3、无返回值1010/23短信接收接口接收短信流程说明：流程说明接收短信流程说明：由应用系统提前在OpenMAS根底组件注册插件，并登记用于接收短信的URL；然后OpenMAS根底组件从短信网关接收短信信息；OpenMAS组件依据插件注册时登记的URLURL对应的NotifySMS方法；集团客户应用系统收到OpenMAS的调用，猎取上行短信唯一标识的MessageID；集团客户应用系统调用OpenMAS组件方法〔GetMessage〕，猎取上行短信的具体内容。调用方式接口接口接口定义发起方落地方说明上行短信通知上行短信通知NotifySmsOpenMAS应用系统应用系统必需提前注册对应插件接收短信GetMessage应用系统OpenMAS上行短信通知方法(NotifySms)发起方：OpenMas平台落地方：应用系统voidNotifySms(stringMessageID);恳求参数定义1、MessageID：上行短信唯一标识，用来猎取信息〔类型：string〕返回值定义2、无返回值接收短信方法(GetMessage)发起方：应用系统落地方：OpenMas平台SmsMessageGetMessage(stringMessageID);恳求参数定义1MessageID：上行短信唯一标识〔类型：string〕返回值定义返回指定应用程序的上行短信。〔类型：SmsMessage数组〕,类型说明如下：1Message：短信正文〔string〕2ReceivedAddress：接收方地址〔string〕3SendAddress：发送方地址〔string〕短信数据库接口集团客户应用系统与OpenMASSQLSERVER2023，同时数据库部署在OpenMAS根底组件侧。业务功能集团客户应用系统通过此接口实现短信的收发和状态查询送短信到数据库，OpenMAS从数据库中猎取待发短信并进展发送。在提交短信发送恳求之后，OpenMAS回写状态报告到短信发送结果表。短信发送接口业务流程应用系统应用系统中间数据库OpenMAS提交短信猎取待发送短信发送短信猎取状态报告提交状态报告猎取状态报告流程说明:应用系统提交待发送短信到中间数据库；OpenMAS根底组件定期从中间数据库中猎取待发送短信；OpenMAS根底组件发送短信；OpenMAS根底组件猎取短信的状态报告；OpenMAS根底组件提交状态报告到中间数据库；1212/23 应用系统定期从数据库猎取状态报告。表构造说明短信待发送表：COM_SmsSent_+扩展号，如：COM_SmsSent_1字段名IDMessageID数据类型IntString长度-50必填是是描述主键短信编号备注自动生成使用GUIDApplicationIDString40是应用程序编号OpenMAS根底组件上注册的账号MessageContentString1000否发送的短信内容SendAddressString40是根底接入号ExtendCodeString40否接入号扩展码DestinationAddressString40是短信接收手机SendTimeDateTime-否短信创立时间默认取当前时间注：短信待发送表中的数据被发送后，OpenMAS根底组件将自动删除。短信状态报告表：(DELIVRD表示成功)(DELIVRD表示成功)CreateTimeDateTime-是状态报告返回时间字段名数据类型长度必填描述备注IDApplicationIDIntString-40是是主键应用程序编号标识字段，自动递增MessageIDString50是短信编号必需为唯一值SendAddressString40否根底接入号ExtendCodeString40否接入号扩展码DestinationAddressSendStatusStringInt40-是否短信接收手机短信提交结果0GatawayStatusString20否短信发送结果网关返回错误注：应用程序务必删除已读取的状态报告，以免表数据越来越大影响性能。另外，假设OpenMAS从短信网关未猎取到状态报告，则短信状态报告表中将没有数据。1313/23短信接收接口业务流程应用系统应用系统中间数据库OpenMAS猎取上行短信提交到数据库猎取短信流程说明:OpenMAS根底组件从行业网关猎取上行短信；OpenMAS根底组件将上行短信提交到中间数据库；应用系统定期从中间数据库猎取上行短信。表构造说明短信上行表COM_SmsIn_+扩展码，如：COM_SmsIn_1字段名数据类型长度必填描述备注IDInt-是主键递增MessageIDString50是短信编号必需为唯一值ApplicationIDString40是应用程序编号MessageContentString1000否上行的短信内容SendAddressString40是上行手机号码DestinationAddress StringDestinationAddress StringExtendCode StringCreateTime DateTime4040-是否否根底接入号接入号扩展码上行时间注：应用程序务必删除已读取的上行短信，以免表数据越来越大影响性能。WebService接口业务功能集团客户应用系统通过此接口实现彩信的收发和状态查询。集团客户应用系统调用SendMessage接口发送彩信，OpenMASOpenMAS依据集团客户预先注册的插件主动通知彩信发送状态。彩信表示标准元素属性说明<masmms>-元素属性说明<masmms>-根元素消息体,消灭屡次,并且在content中没有消灭smil文件,则按挨次显示,smil文件,smil掌握显示contentType属性包括:contentid<content>ContentType:mime内容类型contentLocationContentid:smilid,smil,则charset可自行定义.媒体对象的文件名Charset:编码格式,可选1515/23Content-Type支持格式：TEXT:text/plainXML:text/xmlSMIL:application/smilAMR:audio/amrMIDI:audio/midiGIF:image/gifJPEG:image/jpegWBMP:image/vnd.wap.wbmpPNG:image/pngXml例如：<?xmlversion=“1.0“encoding=“utf-8“?><masmms><contentcontentType=“image/gif“charset=““contentId=“1.gif“contentLocation=“1.gif“>R0lGODlhgACAAPf/ hDjEijV1ELSAAOw==</content><contentcontentType=“text/plain“charset=““contentId=“1.txt“contentLocation=“1.txt“>uafPsreissY=</content><contentcontentType=“application/smil“charset=““contentId=“2.smil“contentLocation=“2.smil“>PHNtaWw+PGhlYWQ+PGxhe eT48L3NtaWw+</content></masmms>假设Content中没有SMILlContent在xmlSMIL1717/23 彩信发送接口流程说明 发送流程说明：发集团客户应用系统在OpenMAS根底组件上注册〔并登记状态报告的接收UR，并OpenMAS根底组件上生成账号；集团客户应用系统调用OpenMAS根底组件的sendMessageOpenMAS接收到彩信，然后将彩信发送到彩信网关；OpenMAS接收彩信网关的状态报告〔结果回执；OpenMASURLNotifyMmsDeliveryReport方法〔带上回1818/23执的结果参数。集团客户应用系统猎取到具体的状态报告信息。调用方式接口接口接口定义发起方落地方说明发送彩信SendMessage应用系统OpenMAS应用系统必需提前注册通知发送状态 NotifyMmsDeliveryReportOpenMAS应用系统对应插件发送方法(SendMessage)发起方：应用系统落地方：OpenMas平台stringSendMessage(stringApplicationID,stringPassword,string[]DestinationAddresses,stringSubject,stringContent);stringSendMessage(stringApplicationID,stringPassword,string[]DestinationAddresses,stringSubject,stringContent,stringExtendCode);stringSendMessage(stringApplicationID,stringPassword,string[]DestinationAddresses,stringSubject,stringContent,stringExtendCode,PriorityPriority);恳求参数定义ApplicationIDID〔string〕2Password：应用程序发送彩信密码，用来防止有人恶意发送彩信〔类型：string〕3DestinationAddresses：彩信接收方号码，可同时发多人〔string〕4ExtendCode：由该应用填写的应用内部扩展号码。5Subject：主题〔string〕值名称描述0Default缺省消息优先级值名称描述0Default缺省消息优先级11Low低的消息优先级2Normal正常的消息优先级3High高的消息优先级7Contentxml3.2.3〔string〕返回值定义7、返回此次发送信息的唯一标识符，用于用户查询发送状态。类型：string彩信发送状态通知接口〔NotifyDeliveryStatus〕发起方：OpenMas平台落地方：应用系统限制条件：应用系统必需注册指定插件voidNotifyMmsDeliveryReport(DeliveryReportDeliveryReport);恳求参数定义1、deliveryReport：彩信发送状态〔见彩信发送状态表〕0Delivered发送成功。1WaitingForDelivery等待发送。2WaitingForDeliveryStatus0Delivered发送成功。1WaitingForDelivery等待发送。2WaitingForDeliveryStatus已发送,等待状态报告。3DeliveryFailed发送失败。ReceivedAddress：接收方地址〔string〕StatusCode：状态码，假设发送失败可确定错误缘由〔string〕SendAddress：发送地址MessageId：发送标识返回值定义3、无返回值2020/23 彩信接收接口流程说明接收短信流程说明：由应用系统提前在OpenMAS根底组件注册插件，并登记用于