移动代理服务器MAS短信API2.2开发⼿册（JAVA）移动代理服务器MAS 短信API2.2
开发⼿册
（JAVA）
V2.2
深圳市嘉讯软件有限公司
⼆○○七年⼗⼀⽉
⽬录
1 引⾔ (1)
1.1 编写⽬的 (1)
1.2 背景说明 (1)
1.3 术语定义 (1)
2 概述 (3)
2.1 接⼝功能 (3)
2.2 接⼝组成 (4)
2.3 短信收发机制 (4)
2.3.1 MT短信与其回执、回复的对应 (4)
2.3.2 MO短信的分流 (5)
3 接⼝介绍 (6)
3.1 接⼝管理模块 (6)
3.1.1 主页⾯ (6)
3.1.2 新建页⾯ (7)
3.1.3 编辑页⾯ (9)
3.1.4 队列管理页⾯ (9)
3.2 数据库DB接⼝ (10)
3.2.1 发送队列表 (11)
3.2.2 接收队列表 (13)
3.2.3 回执队列表 (13)
3.3 Java API (13)
3.3.1 类APIClient (14)
3.3.2 类MOItem (28)
3.3.3 类RPTItem (29)
4 使⽤指导 (29)
4.1 开发步骤 (29)
4.2 调试⽅法 (30)
4.3 运⾏设置与监控 (31)
5 附录 (32)
5.1 附录⼀：API返回值列表 (32)
5.2 附录⼆：回执编码列表 (33)
1引⾔
1.1 编写⽬的
移动代理服务器MAS提供了强⼤的短信接⼊机制。本⼿册⽤于指导客户利⽤移动代理服务器MAS提供的短信接⼝进⾏其他需要短信功能的新系统开发或原有系统的短信功能扩展。
本⼿册的阅读对象为需要采⽤移动代理服务器MAS的短信接⼝完成客户开发的设计⼈员与编码⼈员。
1.2 背景说明
本⼿册适⽤于产品“移动代理服务器MAS” V1.1 + MAS1.1 P08D071121通⽤补丁。
1.3 术语定义
移动代理服务器MAS：全称为“移动代理服务器MAS”，属深圳嘉讯软件公司开发的⼀套
产品，本⼿册中有时也直接简称为“移动代理服务器”或“MAS”。
MT短信：通过短信接⼝发往⼿机终端的短信，也指从移动代理服务器的某
⼀功能直接发往⼿机终端的短信。
MO短信：从⼿机终端发往移动代理服务器的短信，这些短信根据特定的规
则有的直接转交到移动代理服务器的某⼀具体功能，有的转交到
某⼀短信接⼝的接收队列。
短信回执：有时也称“状态报告”，对于MT短信，⼿机终端收到后会返回短
信回执给移动代理服务器。对于短信接⼝，在创建接⼝时，回执
选择为⽀持回执，则通过发送队列发送出去的所有MT短信随后都
会在回执队列中收到对应的回执。回执包含MT短信是否成功提交
到特定⼿机终端的信息。
短信回复：对于MT短信，⼿机终端收到后可以使⽤短信回复功能回复⼀条短信，对于通过发送队列发送的MT短信，其回复短信随后都可以从
接收队列中获得。如果接⼝设置为⽀持短号，则不能直接回复接
⼝所发出的短信。
接⼝编码：某套短信接⼝的唯⼀标识，在创建接⼝时设置，随后不允许修改。短信⼦码：也称“短信⼦号”，每套短信接⼝都拥有⼀个特定数字，这个特定数字由短信收发机制所使⽤，其具体作⽤请参照章
节2.3.1
⼿机指令：有时也称“命令字”或“指令”，每套短信接⼝可以设置⼀个⼿机指令，由字母或数字组成的，⽤户可以使⽤此指令主动发送MO
短信到MAS，其作⽤请参照章节2.3.2
2概述
移动代理服务器MAS不仅为各种类型的集团客户直接提供了丰富的短信业务应⽤功能，⽽且提供强⼤的短信接⼊机制。
此机制允许客户再接⼊任何其他系统以开发此系统的短信应⽤功能，从⽽使拥有移动代理服务器MAS的客户相当于拥有了⼀个属于⾃⼰的“袖珍型短信⾏业⽹关”
2.1 接⼝功能
移动代理服务器MAS的短信接⼊机制所提供的功能是很强⼤的：
n⽀持MT短信的发送、MO短信的接收。
n所发送的MT短信可包括多达2000个汉字。
n⽀持MT短信的回执确认。
n⽀持MT短信的回复会话。
n⽀持⾃定义MT短信在⼿机上显⽰的号码。
n⽀持定时发送MT短信。
n可提供多套短信接⼝，从⽽⽀持多套不同系统的接⼊。
n⽀持通过分配给接⼝的短信⼦码来接收MO短信。
n⽀持通过接⼝设置的⼿机指令来接收MO短信。
n对通过接⼝发送的短信可以进⾏短信内容过滤。
n对通过接⼝发送的短信可以进⾏⿊⽩名单的控制。
n所有接⼝的收发短信都有话单记录
n可以出丰富的接⼝短信话单报表。
n提供接⼊的多种语⾔开发包。
n提供不受任何具体开发语⾔约束的数据库接⼊。
n提供开发⽤的调试环境。
n提供短信收发的监控功能。
n⽀持WAP Push短信。
2.2 接⼝组成
移动代理服务器MAS的短信接⼝包括如下部分：
组成部分功能说明
接⼝管理模块⽤于短信接⼝的创建、设置、监控；⽤于开发时的辅助调试。
各种语⾔包⽤于各种语⾔的API调⽤，⽀持⽬前主流的语⾔，如：C++，
DotNet，Java，ASP，VB，PowerBuilder，Delphi等。
数据库接⼝⽤于其他系统直接通过访问数据库来进⾏短信的收发。
2.3 短信收发机制
2.3.1MT短信与其回执、回复的对应
外部系统利⽤移动代理服务器MAS的短信接⼝进⾏MT短信的发送时，可以为每条MT短信提供指定⼀个短信编号（也称短信ID），那么随后这条短信的回执就会带上同样的短信编号。这样外部系统通过发送MT短信时所⽤的短信编号就可以辨识出随后针对这条短信的回执。
怎样设置代理服务器短信编号可以是1到99999999之间的任何⼀个整数。如果外部系统需要随后能辨别出每条MT短信的回执功能，那么外部系统必须确保在⼀定的时间段内所发送的每条MT 短信都有唯⼀的短信编号。
短信下发时还可以指定⼀个在⼿机上显⽰的尾号（也称SRCID），回复短信时，就是通过srcid识别对
应短信的。如果不指定srcid，则使⽤短信编号作为⼿机尾号。例如：sp特服号为：106910050，短信⼦码为：16，srcid指定为：123，则发送到⼿机上显⽰的号码为：10691005016123.⽤户回复此条短信，则外部系统可以正确收到此条短信的回复。
对于某些MT短信，外部系统可能不需要辨识其回执、回复。对于这类短信，在发送时都可以指定其短信编号为0。
2.3.2MO短信的分流
移动代理服务器MAS可以⽀持⼏⼗套短信接⼝，那么移动代理服务器MAS怎样确保⼿机⽤户主动发起的MO短信能准确的达到某套短信接⼝呢？这有如下两种⽅法：短信⼦码分流。在创建⼀套短信接⼝时，移动代理服务器会要求⽤户为此接⼝分配⼀个短信⼦码，随后MO短信就可以通过短信⼦码的辨识⽽到达此接⼝。举例如下：假设发往此信移动代理服务器所⽤的⽬的号码为106910050，⽽某1套短信接⼝所分配的短信⼦码为5，则⼿机⽤户若要到此接⼝，只要发往⽬的号码1069100505则可。
⼿机指令分流。对于每套短信接⼝，移动代理服务器允许客户为此短信接⼝指定⼿机指令，那么随后以此⼿机指令提交的短信，即使⽬的号码不带短信⼦码，此短信也可到达此短信接⼝。举例如下：
假设发往此移动代理服务器所⽤的⽬的号码为106910050，短信分隔符是“#”，⽽某⼀套短信接⼝设置有⼿机指令为BANK，则⼿机⽤户发往106910050的所有短信，只要短信内容为BANK#……，则BANK#后⾯的短信内容都会到达此接⼝。
3接⼝介绍
3.1 接⼝管理模块
登录移动代理服务器后，只要⽤户权限允许，⽤户可以在系统管理菜单下访问“接⼝管理”模块。利⽤此功能模块，可以对接⼝进⾏图形化创建、维护、设置、监控、或进⾏客户开发的调试辅助。
如果⽤户⽆法访问“系统管理—〉接⼝管理”，应联系移动代理服务器的系统管理员授权。
3.1.1主页⾯
接⼝管理的主页⾯如下：
接⼝管理包括短信接⼝和彩信接⼝管理。
短信接⼝管理的主页⾯主要包括4个按钮与⼀个列表。所创建的每个接⼝在列表上有1条记录，通过此列表可以查阅每个接⼝的基本信息。
列表上⽅各按钮功能如下：
n新建：⽤于创建⼀套新的短信接⼝，
n编辑：⽤于编辑已存在短信接⼝的某些属性
n删除：删除⼀套已存在的短信接⼝。
n队列管理：可以查阅正在发送队列、接收队列、回执队列中排队的短信记录，同时⽤于清除⼀些⾮法的短信记录。配合暂停功能（调试状态），可⽤于外系统短信接⼊开发中的调试。
3.1.2新建页⾯
通过主页⾯的“新建”按钮创建接⼝时，就会弹出如下新建页⾯：
通过如上页⾯就可以创建⼀个接⼝。如上页⾯的各输⼊元素如下：
n接⼝编码：接⼝的编码标识符，任意英⽂字母及数字组成，不能重复。
n接⼝名称：接⼝的描述性名称，便于开发⽤户记忆⽅便。
n接⼝类型：包括DB类型、API类型，WEB Service和Socket接⼝四种类型。DB接⼝：表⽰开发⽤户可以通过任何途径（JDBC，ODBC，其它API等）连接上MAS的数据库，即可进⾏短信的收发。API类型，是提供各种语⾔的API接⼝，⽅便⽤户进⾏开发。
WEB Service类型提供可以以Web Service的⽅式进⾏短信收发。Socket类型提供可
以以Socket的⽅式进⾏短信收发。后两种接⼝的开发⼿册不在此⽂档中描述，另有⽂档专门对其说明。
n业务类型：接⼝所属的业务应⽤类型，设置时应该设置业务已开通短信能⼒的业务类型。否则接⼝的短信不能发送出去。
n业务代码：接⼝时使⽤的业务代码。业务代码在“系统管理->业务设置->业务代码维护”中管理。
n短信⼦码：也称“短信⼦号”，其值是由“系统管理->业务设置->短信⼦号维护”中设置的。已经使⽤过的⼦码不会在下拉列表中出现。
n⼿机指令：可以为接⼝设置⼿机指令，当主动上发短信到接⼝时可以使⽤此指令发送，也可以不设置。
n短号⽀持：包括启⽤，关闭；启⽤表⽰发送出去的短信srcID不带流⽔号，这样的短信就不能直接通过⼿机回复到接⼝。
n回执要求：包括⽀持回执，不⽀持回执，后者在DB接⼝中不提供回执队列表，在API 接⼝中回执获取函数返回永远为null.
n登录⽤户：对应DB接⼝建⽴数据库连接的⽤户名，或API接⼝init函数的loginName 参数。
n登录密码：对应DB接⼝建⽴数据库连接的⽤户密码，或API接⼝init函数的loginPWD 参数。
n接⼝状态：包括运⾏状态、调试状态和暂停（失效）状态三种类型。当在接⼝连接开发中时，应设置接⼝为调试状态，这时候队列管理页⾯可作为调试时的模拟⽹关，此时短信接⼝是还没有接⼊真实的短信⽹关的。当开发完投⼊运⾏时，应设置接⼝为运⾏状态，这样短信接⼝就接⼊了真实的短信⽹关。当接⼝处于暂停（失效）状态时，接⼝不起作⽤，不发送或接收短信。n失效⽇期：API接⼝的失
效⽇期。当接⼝状态为：运⾏或者调试状态时，设置的失效⽇期必须⼤于当前⽇期；当接⼝到达失效⽇期后，接⼝状态⾃动设置为暂停（失效）状态。
3.1.3编辑页⾯
通过主页⾯的“编辑”按钮编辑某接⼝时，就会弹出如下编辑页⾯：
通过如上页⾯就可以修改⼀个接⼝。页⾯上的各个元素的含义与新增接⼝页⾯是⼀样的，但有如下⼏个元素不能修改：
n接⼝编码：编码不能修改。
n登录⽤户：登录⽤户名称不能修改。
3.1.4队列管理页⾯
通过主页⾯的“队列管理”按钮，就可以进⼊如下队列管理页⾯：
n发送队列：利⽤此页⾯可查看或清除尚在发送队列表的某些记录。
n接收队列：利⽤此页⾯可查看或清除尚在接收队列表的某些记录。
n回执队列：利⽤此页⾯可查看或清除尚在回执队列表的某些记录。
在调试状态时，如上Tab⼦页都提供了“删除”“添加”按钮，这样利⽤其添加、删除记录的功能，就可以模拟短信⽹关接收上⾏的MT短信，并下⾏MO短信、MT短信回执。
在运⾏状态时，如上Tab⼦页上不会出现“删除”“添加”按钮。⽤户仅能通过队列管理页⾯查看当前3个队列的排队情况。
3.2 数据库DB接⼝
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论