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

中国移动浙江公司OpenMAS移动代理服务器软件产品基础组件接口设计文档v1.01/232010.062/23目录1.概述.............................................................................................................................................31.1.文档概述...........................................................................................................................31.2.引用标准...........................................................................................................................32.OpenMAS业务简介.....................................................................................................................42.1.OpenMAS业务定义..........................................................................................................42.2.OpenMAS业务特征..........................................................................................................43.接口说明......................................................................................................................................53.1.短消息接口.......................................................................................................................53.1.1.业务功能................................................................................................................53.1.2.流程说明................................................................................................................93.1.3.数据类型定义........................................................................错误!未定义书签。3.1.4.短信发送(SendSMS)接口.....................................................错误!未定义书签。3.1.5.短信接收(GetSms)接口........................................................错误!未定义书签。3.2.彩信接口.........................................................................................................................143.2.1.业务功能..............................................................................................................143.2.2.流程说明..............................................................................................................173/233.2.3.彩信表示规范......................................................................................................143.2.4.数据类型定义........................................................................错误!未定义书签。3.2.5.彩信发送(SendMMS)接口....................................................错误!未定义书签。3.2.6.彩信接收(GetReceivedMms)接口........................................错误!未定义书签。1.概述1.1.文档概述本文档描述了OpenMAS组件与SI/EC平台交互的接口，包括短信、彩信、。1.2.引用标准[1]中国移动通信集团公司《省BOSS与业务管理平台（业务平台）接口规范（暂行）》（V1.1.0）[2]中国移动通信集团公司《全网行业应用业务规范》[3]中国移动通信集团公司《中国移动一级BOSS系统接口规范-全网行业应用-SMS业务单行本-IAGW-M部分2.0.0》[4]中国移动通信集团公司《中国移动一级BOSS系统接口规范V1.4.5》[5]中国移动通信集团公司《省行业网关开发全网行业应用总体技术要求－报批稿》[6]中国移动通信集团公司《省BOSS与省行业网关接口规范1.1.2》4/232.OpenMAS业务简介2.1.OpenMAS业务定义OpenMAS，即OpenMobileAgentServer，其将行业客户的各类应用与移动通信业务应用集成结合，实现SMS（ShortMessageService）、USSD（UnstructuredSupplementaryServiceData）、MMS（MultimediaMessagingService）、WAP（WirelessApplicationProtocol）、KJava（KiloJAVA）等方面的移动数据应用，是沟通集团客户IT应用环境与移动网络之间的桥梁，为集团客户提供面向移动网络的统一的界面和接口，并可衍生出结合移动终端和其它移动应用的新的应用系统，丰富集团客户应用；对集成集团客户已有系统，OPENMAS系统可以简化开发流程、缩短开发周期，可以快速在已有应用系统中集成移动化功能，也可以根据OPENMAS系统开发针对性的移动应用。2.2.OpenMAS业务特征与OPENMAS服务器所具备的特殊地位对应，可以将OPENMAS服务器的应用分为三个层次。作为集团客户应用系统的统一移动接入手段：为集团客户应用系统提供包括短信、彩信、USSD、WAP、WEB、定位等在内的统一通信能力。功能的侧重点是提供通信能力的支持。在这个层次，MAS作为统一移动接入能力提供者，不参与业务的核心逻辑；实现集团客户应用的移动化：将集团客户IT系统的应用环境扩展到移动网络，从而实现移动化的集团客户应用。此时，移动化成为集团客户应用系统必备的功能需求，MAS服务器也成为集团客户应用系统不可或缺的部分。为了实现移动化的需求，集团客户应用系统不需要进行大的改动，在MAS服务器上需对集团客户应用系统的功能进行必要的扩充，MAS服务器成为集团客户应用系统的延伸。5/23提供新业务：在MAS服务器上运行一个或多个应用模块。MAS服务器提供的应用相对独立，或是由于移动网络环境而衍生出的新的业务系统，这些应用也属于集团客户应用系统的范畴，并与其它集团客户应用系统共同使用MAS服务器所提供的接入和移动化支撑功能。3.接口说明3.1.短消息WebService接口3.1.1.业务功能集团客户应用系统通过此接口实现短信的收发和状态查询。集团客户应用系统调用SendMessage接口发送短信，OpenMAS接收请求进行发送。在提交短信发送请求之后，OpenMAS根据集团客户预先注册的插件主动通知短信发送状态。6/233.1.2.短信发送接口3.1.2.1.流程说明发送接口描述：集团客户应用系统在OpenMAS基础组件上注册（并登记状态报告的接收URL），并在OpenMAS基础组件上生成账号；集团客户应用系统调用OpenMAS基础组件的sendMessage接口，发起短信发送的操作；OpenMAS接收到短信，然后将短信发送到短信网关；OpenMAS接收短信网关的状态报告（结果回执）；OpenMAS根据注册的URL，调用基础组件的NotifySmsDeliveryReport方法（带上回执的结果参数）。集团客户应用系统获取到具体的状态报告信息。7/233.1.2.2.调用方式接口接口定义发起方落地方说明发送短信SendMessage应用系统OpenMAS通知发送状态NotifySmsDeliveryStatusOpenMAS应用系统应用系统必须提前注册对应插件3.1.2.3.发送方法(SendMessage)发起方：应用系统落地方：OpenMas平台stringSendMessage(stringApplicationID,stringPassword,string[]DestinationAddresses,stringMessage);stringSendMessage(stringApplicationID,stringPassword,string[]DestinationAddresses,stringMessagestringExtendCode);备注：消息内容Message为UTF-8编码。请求参数定义1、ApplicationID：应用程序ID（类型：string）2、Password：应用程序发送短信密码，用来防止有人恶意模仿应用程序发送短信（类型：string）3、DestinationAddresses：短信接收方号码，可同时发多人（类型：string数组）4、ExtendCode：由该应用填写的应用内部扩展号码。（类型：string）5、Message：短信内容（类型：string）返回值定义6、返回此次发送信息的唯一标识符，用于用户查询发送状态。(类型：string)3.1.2.4.状态报告方法(NotifySmsDeliveryReport)发起方：OpenMas平台落地方：应用系统8/23限制条件：应用系统必须注册指定插件voidNotifySmsDeliveryReport(DeliveryReportdeliveryReport);请求参数定义deliveryReport：短信发送状态，与发送请求数组一一对应（类型：DeliveryReport）1、DeliveryStatus：发送状态（DeliveryStatus），枚举类型0Delivered发送成功。1WaitingForDelivery等待发送。2WaitingForDeliveryStatus已发送,等待状态报告。3DeliveryFailed发送失败。2、ReceivedAddress：接收方地址（string）3、StatusCo