中国移动代理服务器MAS V2.0
WebService接口插件
开发手册
深圳市嘉讯软件有限公司
2008年9月
中国移动代理服务器MAS V2.0 WebService接口开发手册
目录
1.
引言 ................................................................................................................................... 4 1.1. 编写目的 ................................................................................................................... 4 1.2. 背景说明 ................................................................................................................... 4 1.3. 相关术语与缩略语解释 ........................................................................................... 4 概述........................................................................................................................................... 4 运行环境 ................................................................................................................................... 5 接口描述 ................................................................................................................................... 5 4.1. 短信接口 ................................................................................................................... 5
4.1.1. 接口说明 ........................................................................................................... 5 4.1.2. 流程说明 ........................................................................................................... 5 4.1.3. 数据类型 ........................................................................................................... 6 4.2. 彩信接口 ................................................................................................................... 8
4.2.1. 接口说明 ........................................................................................................... 8 4.2.2. 流程说明 ........................................................................................................... 8 4.2.3. 数据类型 ........................................................................................................... 9 4.3. Wappush短信接口 ................................................................................................. 10
4.3.1. 接口说明 ......................................................................................................... 10 4.3.2. 流程说明 ......................................................................................................... 10 4.3.3. 数据类型 ......................................................................................................... 11 开发步骤 ................................................................................................................................. 12 5.1. 在Mas服务器新建一个企业应用 ........................................................................ 12 5.2. 启动企业应用 ......................................................................................................... 13 5.3. 访问并获取WebService方式通信适配插件服务地址 ....................................... 13 5.4. 客户端及服务端代码生成 ..................................................................................... 13 5.5. 接口开发及使用举例 ............................................................................................. 13
5.5.1. 短信接口 ......................................................................................................... 13
5.5.1.1. sendSms操作 .......................................................................................... 14 5.5.1.2. getSmsDeliveryStatus操作 .................................................................... 15 5.5.1.3. notifySmsDeliveryStatus操作 ................................................................ 16 5.5.1.4. getReceivedSms操作 ............................................................................. 16 5.5.1.5. notifySmsReception操作 ....................................................................... 17 5.5.2. 彩信接口 ......................................................................................................... 17
5.5.2.1. sendMessage操作................................................................................... 17 5.5.2.2. getMessageDeliveryStatus操作 ............................................................. 18 5.5.2.3. notifyMessageDeliveryReceipt操作 ...................................................... 19 5.5.2.4. getReceivedMessages操作 ..................................................................... 20 5.5.2.5. getMessage操作 ..................................................................................... 20 5.5.2.6. notifyMessageReception操作 ................................................................ 21 5.5.3. Wappush短信接口 ......................................................................................... 22
5.5.3.1. sendPush操作 ......................................................................................... 22
2.
3. 4.
5.
2
深圳市嘉讯软件有限公司
中国移动代理服务器MAS V2.0 WebService接口开发手册
5.5.3.2. getPushDeliveryStatus操作.................................................................... 23 5.5.3.3. notifyPushDeliveryReceipt操作 ............................................................ 24
5.6. 常见错误及处理方式 ............................................................................................. 24 6. 参考文档 ................................................................................................................................. 25
3
深圳市嘉讯软件有限公司
中国移动代理服务器MAS V2.0 WebService接口开发手册
1. 引言
1.1. 编写目的
本文档描述了MAS2.0基座WebService通信接口的使用方法，文档的使用对象为MAS开发人员、数字化部队、SI工程技术人员、SI开发人员、集团客户技术人员。
本文档的读者需要有一定的WebService相关知识。
1.2. 背景说明
1.3. 相关术语与缩略语解释
缩写词 MAS HTTP HTTPS SOAP UCA WS 英文解析 Mobile Agent Server Hypertext Transfer Protocol Secure HTTP Simple Object Access Protocol Unified Communication Agent WebService 中文解析 移动代理服务器 超文本传输协议 加密的HTTP协议 简单对象访问协议 统一通信代理 Web服务接口 2. 概述
开发环境WebService方式通信提供了对各种通信能力的统一封装，供集团客户应用系统和MAS服务器应用插件进行调用。同时，提供统一WebService方式封装也降低了si的开发难度，将繁杂的通信能力协议与具体的业务应用分离开来，对si呈现简单的标准接口。WebService方式通信适配插件接口封装了以下移动通信能力： ? 短信 ? 彩信 ? wappush ? ussd(暂不可用) ? LBS(暂不可用)
此外，还提供基座与应用插件之间的插件管理功能接口。
MAS服务器应提供配置工具，指定对于某个集团客户应用系统或应用插件，通过WebService方式通信适配插件或数据库方式通信适配插件接入MAS服务器。
4
深圳市嘉讯软件有限公司
中国移动代理服务器MAS V2.0 WebService接口开发手册
3. 运行环境
? MAS2.0基座运行环境 ? MAS管理平台环境
? WebService适配插件开关打开
4. 接口描述
4.1. 短信接口
4.1.1.
接口说明
集团客户应用系统和应用插件通过此接口收发短消息。WebService方式通信适配插件收到应用插件的发送请求后，通过MAS服务器基座中的SMS通信协议模块发送SMS；当从SMS通信协议模块收到SMS后，通过此接口将短消息发送给集团客户应用系统和应用插件。
4.1.2. 流程说明
短消息接口包括发送和接收两个流程。
应用系统或应用插件WebService方式通信适配插件应用发送短信sendSmsRequestsendSmsResponse应用主动获取短信发送状态getSmsDeliveryStatusRequestgetSmsDeliveryStatusResponse通知应用短信发送状态notifySmsDeliveryStatusRequestnotifySmsDeliveryStatusResponse 图5-2 短消息发送流程示意图
发送短信由应用系统或应用插件发起，通过sendSms操作实现。在提交短信发送请求
5
深圳市嘉讯软件有限公司