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

中国移动浙江公司

OpenMAS移动代理服务器软件产品

基础组件接口设计文档v1.0

中国移动通信I-POWER

CHINAMOBILEG

*动ae~Q«H71IOO

2010.06

修动信息,家

1/28

中国移动通信I-POWER

CHINAMOBILEGH71IOO

移动信息♦家

目录

1.概述.....................................2

1.1.文档概述.................................................................2

1.2.引用标准.....................................................................2

2.OpenMAS业务简介...........................................................3

2.1.OpenMAS业务定义.........................................................3

2.2.OpenMAS亚务特征.............................................................3

3.接口说明....................................................................4

3.1.短消息接口...........................................................4

3.1.1.业务功能...........................................................4

3.1.2.流程说明...........................................................4

3.1.3.数据类型定义.......................................................6

3.1.4.短信发送知6词5\15）接口.............................................7

3.1.5.短信接收归0。15）接口...................................................8

3.2.彩信接口............................................................10

3.2.1.业务功能..........................................................10

3.2.2.流程说明..........................................................10

2/28

也

中国移动通信i-POWER

CHINAMOBILE

ae~Q«ctl71IOO

3.2.3.彩信表示规范......................................................II

3.2.4.数据类型定义......................................................13

3.2.5.彩信发送(SendMMS)接口...........................................14

3.26彩信接收(GelReceivedMms)接口16

1.概述

1.1.文档概述

1.2.本文档描述了OpenMAS组件与SI/EC平台交互的接

口，包括短信、彩信、。

1.3.引用标准

[1]中国移动通信集团公司《省BOSS与业务管理平台（业务平台）接口规范（暂行）》

（VL1.0）

[2]中国移动通信集团公司《全网行业应用业务规范》

[3]中国移动通信集团公司《中国移动一级BOSS系统接口规范-全网行业应用-SMS业

务单行本.IAGW-M部分2.0.0》

[4]中国移动通信集团公司《中国移动级BOSS系统接口规范VI.4.5》

[5]中国移动通信集团公司《省行业网关开发全网行业应用总体技术要求一报批稿》

⑹中国移动通信集团公司《省BOSS与省行业网关接口规范1.1.2》

3/28

中国移动通信I-POWER

CHINAMOBILEG

*动ae~Q«H71IOO

4/28

筠中国移动通信I-POWER

CHINAMOBILEGH71IOO

if_~a~~e~鼻~~«■a”■力■

2.OpenMAS业务简介

2.1.OpenMAS业务定义

2.2.OpenMAS,即OpenMobileAgentServer,其将行

业客户的各类应用与移动通信业务应用集成结合，实现

SMSCShortMessageService)xUSSD(Unstructured

SupplementaryServiceData)、MMS(Multimedia

MessagingService)、WAP(WirelessApplication

Protocol)、KJava(KiloJAVA)等方面的移动数据

应用，是沟通集团客户IT应用环境与移动网络之间的桥

梁，为集团客户提供面向移动网络的统一的界面和接口,

并可衍生出结合移动终端和其它移动应用的新的应用系

统，丰富集团客户应用；对集成集团客户已有系统,

OPENMAS系统可以简化开发流程、缩短开发周期，可

以快速在已有应用系统中集成移动化功能，也可以根据

OPENMAS系统开发针对性的移动应用。

2.3.OpenMAS业务特征

/与OPENMAS服务器所具备的特殊地位对应，可以将OPENMAS服务器的应用分为三个

层次。

5/28

中国移动通信I-POWER

CHINAMOBILEGH71IOO

ae~Q«■a”■力■

/作为集团客户应用系统的统一移动接入手段：为集团客户应用系统提供包括短信、

彩信、USSD.WAP、WEB.定位等在内的统一通信能力。功能的侧重点是提供通信能力

的支持。在这个层次，MAS作为统一移动接入能力提供者，不参与业务的核心逻辑;

6/28

中国移动通信»-POWER

VXCHINAMOBILE前力||QQ

移动信息寿本■力.

3.实现集团客户应用的移动化：将集团客户

IT系统的应用环境扩展到移动网络，从

而实现移动化的集团客户应用。此时，移

动化成为集团客户应用系统必备的功能

需求,MAS服务器也成为集团客户应用

系统不可或缺的部分。为了实现移动化的

需求，集团客户应用系统不需要进行大的

改动，在MAS服务器上需对集团客户应

用系统的功能进行必要的扩充，MAS服

务器成为集团客户应用系统的延伸。

4.提供新业务：在MAS服务器上运行一个

或多个应用模块。MAS服务器提供的应

用相对独立，或是由于移动网络环境而衍

生出的新的业务系统，这些应用也属于集

团客户应用系统的范畴，并与其它集团客

户应用系统共同使用MAS服务器所提供

的接入和移动化支撑功能。

5.接口说明

5.1.短消息WebService接口

7/28

中国移动通信I-POWER

CHINAMOBILEG

ae~Q«H71IOO

5.1.1.业务功能

5.1.2.集团客户应用系统通过此接口实现短信的收发和状态

查询。集团客户应用系统调用SendMessage接口发送

短信，OpenMAS接收请求进行发送。在提交短信发送

请求之后，OpenMAS根据集团客户预先注册的插件

主动通知短信发送状态。

5.1.3.短信发送接口

5.I.3,X.流程说明

•集团客户应用系统在OpenMAS基础组件上注册（并登记状态报告的接收URL）,并在

8/28

也

中国移动通信i-POWER

CHINAMOBILE

ae~Q«ctl71IOO

OpenMAS基础组件上生成账号；

•集团客户应用系统调用OpenMAS基础组件的sendMessage接口，发起短信发送的操作；

•OpenMAS接收到短信，然后将短信发送到短信网关：

•OpenMAS接收短信网关的状态报告（结果回执）；

•OpenMAS根据注册的URL,调用基础组件的NotifySmsDeliveryReport方法（带上回执

的结果参数）。

•集团客户应用系统获取到具体的状态报告信息。

5.1.3.2.调用方式

接口接口定义发起方落地方说明

发送短信SendMessage应用系统OpenMAS

应用系统必须

通知发送状态NotifySmsDeliver>StatusOpenMAS应用系统提前注册对应

插件

5.1.3.3.发送方法(SendMessage)

发起方：应用系统

落地方：OpenMas平台

stringSendMessage(stringApplicationlD,stringPassword,string[]Destination.Addresses,

stringMessage)：

stringSendMessage(stringApp]icationID,stringPassword,

string[]DestinationAddresses,stringMessagestringExtendCode);

备注：消息内容Message为UTF-8编码。

请求参数定义

1、ApplicationlD:应用程序ID(类型:string)

2、Password:应用程序发送短信密码，用来防止有人恶意模仿应用程序发送短信(类型：string)

3、DestinationAddresses：短信接收方号码，可同时发多人（类型：string数组）

9/28

也

中国移动通信i-POWER

CHINAMOBILE

ae~Q«ctl71IOO

4、ExtendCode:由该应用填写的应用内部扩展号码。(类型：string)

Message:短信内容(类型：string)

返回值定义

5.1.3.4.返回此次发送信息的唯一标识符，用于用户查询发送状态。(类型：string)

5.13.5.状态报告方法(NotifySmsDeliveryReport)

发起方：OpenMas平台

落地方：应用系统

限制条件：应用系统必须注册指定插件

voidNotifySmsDc1ivcr/Rcport(De1ivcryRcportdclivcryRcport);

请求参数定义

1、deliveryReport:短信发送状态，与发送请求数组一一对应(类型：DeliveryRepori)

DeliveryStatus：发Delivered发送成功。

送状态

(DeliveryStatus),

枚举类型

0

1WaitingForDelivery等待发送。

2WaitingForDeliveryStatus已发送，等待

状态报告。

3DeliveryFailed发送失败。

2、ReceivedAddress:接收方地址(siring)

3、StatusCode：状态码，如果发送失败可确定错误原因(string)

4、SendAddress:发送地址

Messageld:发送标识

返回值定义

10/28

中国移动通信I-POWER

CHINAMOBILEG

ae~Q«H71IOO

5.1.4.3.无返回值

5.1.5.短信接收接口

5.1.5.L流程说明

•由应用系统提前在OpenMAS基础组件注册插件，并登记用于接收短信的URL；

•然后OpcnMAS基础组件从短信网关接收短信信息：

•OpenMAS组件根据插件注册时登记的URL信息，调用URL对应的NotifySMS方法;

11/28

也

中国移动通信i-POWER

CHINAMOBILE

ae~Q«ctl71IOO

5・1.5.2.集团客户应用系统收到OpenMAS的调用，获取上行短信唯

一标识的MessagelD；

5.1.5.3.集团客户应用系统调用OpenMAS组件方法

(GetMessage),获取上行短信的详细内容。

5.L5.4.调用方式

接口接口定义发起方落地方说明

上行短信通知NotifySmsOpenMAS应用系统应用系统必须提前注册对应插件

接收短信GetMessage应用系统OpenMAS

5.1.5.5.上行短信通知方法(NotifySms)

发起方：OpenMas平台

落地方：应用系统

voidNotifySms(stringMessagelD);

请求参数定义

1.MessagelD:上行短信唯一标识,用来获取信息(类型:string)

返回值定义

5.1.5.6.2.无返回值

5.1.5.7,接收短信方法(GetMessage)

发起方：应用系统

落地方：OpenMas平台

SmsMessageGetMessage(stringMessagelD);

请求参数定义

MessagelD:上行短信唯一标识(类型:string)

12/28

中国移动通信I-POWER

CHINAMOBILEGH71IOO

ae~Q«■息”■力■

返回值定义

1、返回指定应用程序的上行短信。(类型：SmsMessage数组)，类型说明如下:

2、Message:短信正文(string)

3、ReceivedAddress:接收方地址(string)

筠中国移动通信I-POWER

CHINAMOBILEGH71IOO

if_~a~~e~鼻~~«■a”■力■

5.2.SendAddress:发送方地址(string)

5.3.短信数据库接口

5.3.1.集团客户应用系统与OpenMAS基础组件的数据库可

接口，只支持SQLSERVER2005,同时数据库部署在

OpenMAS基础组件侧。

5.3.2.业务功能

5.3.3.集团客户应用系统通过此接口实现短信的收发和状态

查询。集团客户应用系统提交待发送短信到数据库,

OpenMAS从数据库中获取待发短信并进行发送。在提

交短信发送请求之后，OpenMAS回写状态报告到短

信发送结果表。

5.3.4.短信发送接口

53.4.1.业务流程

14/28

也

中国移动通信i-POWER

CHINAMOBILE

ae~Q«ctl71IOO

发送短信

获取状态报告

流程说明：

•应用系统提交待发送短信到中间数据库；

•OpenMAS基础组件定期从中间数据库中获取待发送短信;

•OpenMAS基础组件发送短信；

•OpenMAS基础组件获取短信的状态报告；

•OpenMAS基础组件提交状态报告到中间数据库：

•应用系统定期从数据库获取状态报告。

53.4.2.表结构说明

短信待发送表:

COM_SmsScnt_+数据类型长度必填描述备注

扩展号，如：

COM_SmsSent_l

字段名

IDInt-是主键自动生成

MessagelDString50是短信编号必须为唯一值，建

议使用GUID

15/28

也

中国移动通信i-POWER

CHINAMOBILE

ae~Q«ctl71IOO

ApplicationlDString40是应用程序编号OpenMAS基研组件

上注册的账号

MessageContentString1000否发送的短信内容

SendAddressString40是基础接入号

ExtendCodeString40否接入号扩展码

DestinationAddressString40是短信接收手机

SendTimeDateTinie-否短信创建时间默认取当前时间

注：短信待发送表中的数据被发送后,OpenMAS基础组件将自动删除。

短信状态报告表:

COM_SmsReport_+数据类型长度必填描述备注

扩展码，如：

COM_SmsReport_1

字段名

IDInt-是主键标识字段，自动递增

ApplicationlDString40是应用程序编号

MessagelDString50是短信编号必须为唯一值

SendAddressString40否基础接入号

ExtendCodeString40否接入号扩展码

DestinationAddressString40是短信接收手机

SendStatusInt-否短信提交结果0：成功，其他值为失败

GatawayStatusString20否短信发送结果网关返回错误

（DELIVRD表示成功）

CreateTimeDateTime-是状态报告返回

时间

16/28

中国移动通信I-POWER

CHINAMOBILEGH71IOO

移动信息♦家

5・3.5.注：应用程序务必删除已读取的状态报告，以免表数

据越来越大影响性能。

5.3.6.另外，如果OpenMAS从短信网关未获取到状态报告,

则短信状态报告表中将没有数据。

5.3.7.短信接收接口

5.3.7.1.业务流程

获取上行短信

流程说明：

•OpenMAS基础组件从行业网关获取上行短信；

•OpenMAS基础组件将上行短信提交到中间数据库;

•应用系统定期从中间数据库获取上行短信。

17/28

也

中国移动通信i-POWER

CHINAMOBILE

~~S~e_«ctl71IOO

53.7.2.表结构说明

短信上行表

COM_SmsIn_+扩数据类型长度必填描述备注

展码，如：

COM_SmsIn_l

字段名

IDInt-是主键标识字段，自

动递增

MessagelDString50是短信编号必须为唯一值

ApplicationlDString40是应用程序编号

MessageContentString1000否上行的短信内容

ScndAddressString40是上行手机号码

DestinationAddressString40是基础接入号

ExtendCodeString40否接入号扩展码

CreateTimeDateTime-否上行时间

18/28

份中国移动通信i-POWER七

CHINAMOBILE

if_~a~~e~鼻~~«ctl71IOO

5.4.注：应用程序务必删除已读取的上行短信，以免表数

据越来越大影响性能。

5.5.彩信WebService接口

5.5.1.业务功能

5.5.2.集团客户应用系统通过此接口实现彩信的收发和状态

查询。集团客户应用系统调用SendMessage接口发送

彩信，OpenMAS接收请求进行发送。在提交彩信发送

请求之后，集团客户应用系统可以主动请求查询彩信

发送状态，或者由OpenMAS根据集团客户预先注册的

插件主动通知彩信发送状态。

5.5.3.彩信表示规范

彩信可包含

文字、图片和

铃声，所以

采用XML格

属性说明

式来表示一

条彩信。规范

如下：

元素

<masmms>-根元素

19/28

中国移动通信I-POWER

CHINAMOBILE

~~S~e_«GH71IOO

消息体，出现多次,并且在content中没有出现smil

文件，则按顺序显示,如果有smil文件,则按照smil

控制显示

contentType

属性包括：

contentid

<content>ContentType:mime内容类型

contentLocation

Contentid:smil正文中的内容id,如果没有smil,则

charset

可自行定义.

ContentLocation:媒体对象的文件名

Charset:编码格式，可选

Content-Type支持格式：

TEXT:text/plain

XML:text/xml

SMIL:application/smil

AMR:audio/amr

MIDI:audio/midi

GIF:image/gif

JPEG:image/jpeg

WBMP:image/vnd.wap.wbmp

PNG:image/png

Xml示例：

<?xmlversion=，，l.0"encoding="utf-8”?>

<masmms>

<contcnt

contentType-*image/gif”

charset=**contentId=*l.gif*

contentLocation=zr1.gif”>

20/28

中国移动通信I-POWER

CHINAMOBILE

~~S~e_«GH71IOO

ROlGODlhgACAAPf/……..hDjEijVlELSAAOw=

</content>

<contcnt

contentType=*text/plain*

charset=**

contentId="Ltxt"

contentLocation=z，l.ixt”>

uafPsreissY=

</content>

<content

contentType=*application/smil*

charset=**

contentld=*2.smil*

contentLocation="r2.smil*>

PHNtaWw+PGhlYWQ+PGxhe...............eT48L3NtaWw+

</contcnt>

</masmms>

说明：如果Content中没有SMIL1类型文件，文本中文字、图片和音频的显示顺序按照

Content在xml中的先后顺序，如果有，则按照SMIL来控制显示。

21/28

也

中国移动通信i-POWER

CHINAMOBILE

ae~Q«ctl71IOO

5.5.4.彩信发送接口

5.5.4.1.流程说明

•发集团客户应用系统在OpenMAS基础组件上注册〔并登记状态报告的接收URL）,并

在OpenMAS基础组件上生成账号；

•集团客户应用系统调用OpenMAS基础组件的sendMessage接口，发起彩信发送的操作；

•OpenMAS接收到彩信，然后将彩信发送到彩信网关；

•OpenMAS接收彩信网关的状态报告（结果I可执）；

•OpenMAS根据注册的URL,调用基础组件的NotifyMmsDeliveryRepoit方法（带上回执

22/28

中国移动通信i-POWER也

CHINAMOBILE

>f>-S―e―^ictl71IOO

的结果参数）。

集团客户应用系统获取到具体的状态报告信息。

5・5・4・2.调用方式

接口接口定义发起方落地方说明

发送彩信SendMessage应用系统OpenMAS

应用系统必须提前注册

通知发送状态NotifyMmsDeliveryReportOpenMAS应用系统

对应插件

5.5・4.3.发送方法(SendMessage)

发起方：应用系统

落地方：OpenMas平台

stringScndMcssagc(siringApp1icationI[),stringPassword,stringL]DostinationAddrcsses,

stringSubject,stringContent);

stringSendMessage(stringApplicationID,stringPassword,stringL]Destination?\ddresses,

stringSubject,stringContent,stringExtendCode);

stringSendMessage(string.ApplicationID,stringPassword,string[]DestinationAddresses,

stringSubject,stringContent,stringExtendCode,PriorityPriority);

请求参数定义

1、ApplicationlD:应用程序ID(string)

2、Password:应用程序发送彩信密码，用来防止有人恶意发送彩信(类型：string)

3、DestinationAddresses：彩信接收方号码，可同时发多人(string数组)

4、ExtendCode:由该应用填写的应用内部扩展号码。

5、Subject:主题(string)

Priority:优名称描述

先级

(Priority)

23/28

中国移动通信I-POWER

CHINAMOBILEG

ae~Q«H71IOO

值

0Default缺省消息优先级

1Low低的消息优先级

2Normal正常的消息优先级

3H电h高的消息优先级

Content:彩信内容一彩信的刖1表示参见3.2.3彩信表示规范。(string)

返回值定义

5・5・4・4・7、返回此次发送信息的唯一标识符，用于用户查询发送状态。类型：string

5.5・4.5.彩信发送状态通知接口(NotifyDeliveryStatus)

发起方：OpenMas平台

落地方：应用系统

限制条件：应用系统必须注册指定插件

voidNotifyMmsDe1iveryReport(De1iveryReportDeliveryReport)：

请求参数定义

deliveryReport:彩信发送状态(见彩信发送状态表)

DeliveryStatus：发Delivered发送成功。

送状态

(DeliveryStatus),

枚举类型

0

1WaitingForDclivery等待发送。

2WaitingForDciiveryStatus己发送，等待