中国移动代理服务器MAS V2.0 WebService接口开发手册
用服务端向应用系统发出各种消息通知,直到应用系统通过stopNotification通知服务端不可用为止。
应用系统可以多次执行startNotification和stopNotification操作,WebService方式通信适配插件以最后一次的通知为准。
WebService方式通信适配插件在向应用侧发出消息通知失败时,采用指数后退方式重试三次。若重试后仍失败,则抑制后续的所有消息通知。
6.2.3. 接口定义
操作:startNotification
startNotification调用由应用系统发起,通知WebService方式通信适配插件,应用系统的服务端已经开启。应用系统在MessageNotification参数中注明各通信能力对应的服务端URL。
输入:startNotificationRequest 参数 ApplicationId MessageNotification 类型 xsd:string MessageNotificationType[] 可选性 M M 描述 EC应用标识 应用的各通信能力对应的Web服务URL,若对应某通信能力,Web URL不填,表示对于该应用能力,应用插件不提供服务端,或服务端不可用。 输出:startNotificationResponse 无。 差错: 业务异常:
? SVC0001 - 业务错误 ? SVC0002 - 不合法的输入值 ? SVC0005 - 重复关联符 策略异常:
? POL0001 - 策略错误 操作:stopNotification
stopNotification调用由应用系统发起,通知WebService方式通信适配插件该应用系统不再提供服务端。
13
深圳市嘉讯软件有限公司
中国移动代理服务器MAS V2.0 WebService接口开发手册
输入:stopNotificationRequest 参数 ApplicationId 类型 xsd: string 可选性 M 描述 EC应用ID 输出:stopNotificationResponse 无。 差错 业务异常:
? SVC0001 - 业务错误 ? SVC0002 - 不合法的输入值 策略异常:
? POL0001 - 策略错误
6.3. 短信接口
6.3.1.
接口说明
集团客户应用系统和应用插件通过此接口收发短消息。WebService方式通信适配插件收到应用插件的发送请求后,通过MAS服务器基座中的SMS通信协议模块发送SMS;当从SMS通信协议模块收到SMS后,通过此接口将短消息发送给集团客户应用系统和应用插件。
6.3.2. 流程说明
短消息接口包括发送和接收两个流程。
14
深圳市嘉讯软件有限公司
中国移动代理服务器MAS V2.0 WebService接口开发手册
应用系统或应用插件WebService方式通信适配插件应用发送短信sendSmsRequestsendSmsResponse应用主动获取短信发送状态getSmsDeliveryStatusRequestgetSmsDeliveryStatusResponse通知应用短信发送状态notifySmsDeliveryStatusRequestnotifySmsDeliveryStatusResponse 图5-4 短消息发送流程示意图
发送短信由应用系统或应用插件发起,通过sendSms操作实现。在提交短信发送请求之后,应用侧可以主动获取短信发送状态(getSmsDeliveryStatus操作),或由WebService方式通信适配插件通知应用侧短信发送状态(notifySmsDeliveryStatus操作)。
应用系统或应用插件WebService方式通信适配插件应用主动发起接收短信GetReceivedSmsRequestGetReceivedSmsResponse通知应用短信到达notifySmsReceptionRequestnotifySmsReceptionResponse 图5-5 短消息接收流程示意图
接收短信可以通过两种方式,一种是由应用侧发起(GetReceivedSms操作),WebService方式通信适配插件将所接收到的发往该应用的短信在响应中提交;第二种是由WebService方式通信适配插件通知应用侧有短信到达(notifySmsReception操作),短信内容包含在请求
15
深圳市嘉讯软件有限公司
中国移动代理服务器MAS V2.0 WebService接口开发手册
中。
6.3.3. 数据类型
DeliveryStatus 含义:传送状态
数据类型:枚举,定义如下: 参数 Delivered DeliveryUncertain 描述 短消息已成功递交。 递交状态未知:例如,因为短消息被发送到另外一个网络。 DeliveryImpossible MessageWaiting 无法成功发送;短消息在超时前无法被递交。 消息仍在排队等待递交。这是一个临时状态,等待转换为前述的状态之一。 DeliveryToTerminal DeliveryNotificationNotSupported KeyWordFilterFailed DeliveryInformation 含义:传送消息
数据类型:结构。定义如下: 参数 Address DeliveryStatus SMSMessage 含义:短消息信息
数据类型:结构。定义如下: 参数 Message SmsServiceActivationNumber 类型 xsd:string xsd: anyURI 描述 短消息中的文本。 与被调用的消息业务相关的号码,即,终端用来发送消类型 xsd: anyURI DeliveryStatus 描述 目的地址信息。 发送状态。 关键字过滤未通过。 短消息已发给终端。 不支持短消息提交通知。 16
深圳市嘉讯软件有限公司