OpenMas1.2接口开发文档

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

void NotifySmsDeliveryReport(DeliveryReport deliveryReport);

请求参数定义

deliveryReport：短信发送状态，与发送请求数组一一对应（类型：DeliveryReport）

1、 DeliveryStatus：发送状态（DeliveryStatus），枚举类型

0 1 2 3 Delivered WaitingForDelivery WaitingForDeliveryStatus DeliveryFailed 发送成功。 等待发送。 已发送,等待状态报告。 发送失败。 2、 ReceivedAddress：接收方地址（string）

3、 StatusCode：状态码，如果发送失败可确定错误原因（string） 4、 SendAddress：发送地址 5、 MessageId：发送标识 返回值定义

3、无返回值

8 / 27

3.1.3. 短信接收接口

3.1.3.1. 流程说明

?

? 接收短信流程说明：

? 由应用系统提前在OpenMAS基础组件注册插件，并登记用于接收短信的URL； ? 然后OpenMAS基础组件从短信网关接收短信信息；

? OpenMAS组件根据插件注册时登记的URL信息，调用URL对应的NotifySMS方法； ? 集团客户应用系统收到OpenMAS的调用，获取上行短信唯一标识的MessageID； ? 集团客户应用系统调用OpenMAS组件方法（GetMessage），获取上行短信的详细内容。

3.1.3.2. 调用方式

接口 接口定义 发起方 落地方 说明 9 / 27

上行短信通知 接收短信

应用系统必须提前注册对应插件 NotifySms GetMessage OpenMAS 应用系统 应用系统 OpenMAS 3.1.3.3. 上行短信通知方法(NotifySms)

发起方：OpenMas平台 落地方：应用系统

void NotifySms(string MessageID);

请求参数定义

1、MessageID：上行短信唯一标识，用来获取信息（类型：string）

返回值定义

2、无返回值

3.1.3.4. 接收短信方法(GetMessage)

发起方：应用系统 落地方：OpenMas平台

SmsMessage GetMessage(string MessageID);

请求参数定义

1、 MessageID：上行短信唯一标识（类型：string）

返回值定义

返回指定应用程序的上行短信。（类型：SmsMessage数组）,类型说明如下：

1、 Message：短信正文（string）

2、 ReceivedAddress：接收方地址（string） 3、 SendAddress：发送方地址（string）

3.2. 短信数据库接口

集团客户应用系统与OpenMAS基础组件的数据库可接口，只支持SQL SERVER 2005，同时数据库部署在OpenMAS基础组件侧。

10 / 27

3.2.1. 业务功能

集团客户应用系统通过此接口实现短信的收发和状态查询。集团客户应用系统提交待发送短信到数据库，OpenMAS从数据库中获取待发短信并进行发送。在提交短信发送请求之后， OpenMAS回写状态报告到短信发送结果表。

3.2.2. 短信发送接口

3.2.2.1. 业务流程

应用系统提交短信中间数据库OpenMAS获取待发送短信发送短信获取状态报告提交状态报告获取状态报告

流程说明: ? ? ? ? ?

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

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

OpenMAS基础组件获取短信的状态报告； OpenMAS基础组件提交状态报告到中间数据库；

11 / 27