《移动代理服务器mas短信socket api接口协议》由会员分享，可在线阅读，更多相关《移动代理服务器mas短信socket api接口协议（13页珍藏版）》请在金锄头文库上搜索。
1、Mas 移动信息机 SOCKETAPI 协议 1.0 开发手册1移动代理服务器 MAS 短信 SOCKET API 接口协议V1.0嘉讯软件Mas 移动信息机 SOCKETAPI 协议 1.0 开发手册22006-3修订记录ID 修订历史 修改人 日期初稿 V1.0 陈铁钢 2006-3-30初稿 V2.0 陶永江 2007-12-14初稿 V2.1 陈宏海 2008-9-27Mas 移动信息机 SOCKETAPI 协议 1.0 开发手册31 简介本协议用于 MAS 与 通过 API 接入 MAS 的客户端的数据传输通讯。两者的数据传输通讯采用 TCP 协议、短连接方式，MAS 为服务器方，T
2、CP 监听端口为 7301。缩略语清单：SAPP(SOKET API Peer to Peer)：嘉讯socket api接口点对点协议client：所有通过socket api 协议接入 MAS 的客户端MAS(Information Machine)：信息机1.1 API 原理Socket api 短信收发使用原理请参照 MAS 产品发布时附带的文件 MAS 移动信息机 API2.0开发手册 。本文档不再重复阐述。本文档解决的是 如何通过 TCP 连接方式使用 socket api。1.2 SAPP 功能概述本协议主要提供以下两类业务操作：（1） client发送数据到 MAS典型的业务操
3、作为发送短信到 MAS（2） client从 MAS接收数据典型的业务操作为接收 MAS 发送过来的状态报告和 MO 短信2 通信方式2.1 短连接通信交互采用短连接方式。短连接是指通信双方有数据交互时，就建立一个 TCP 连接，数据发送完成后，则断开此 TCP 连接，即每次 TCP 连接只完成一对 SAPP 消息的发送。通信双方以客户-服务器方式建立 TCP 连接，应答与请求在同一个连接中完成。系统Mas 移动信息机 SOCKETAPI 协议 1.0 开发手册4采用客户/服务器模式，操作以客户端驱动方式发起连接请求，完成一次操作后关闭此连接。client 与 MAS 之间消息发送后等待 T
4、秒后未收到响应，应立即重发，再连续发送 N-1次后仍未得到响应则停发。现阶段建议取值为：T=60 秒， N=3。短连接的操作流程举例如图 6 所示：图 1 短连接的操作流程对 SAPP 消息 1 的响应SAPP 消息 1建立 TCP 连接拆除 TCP 连接SAPP 消息 2对 SAPP 消息 2 的响应建立 TCP 连接拆除 TCP 连接. . . . . . 建 立 TCP连 接客户端/服务器端服务器/客户端Mas 移动信息机 SOCKETAPI 协议 1.0 开发手册5过程如下：建立连接：建立连接过程由客户端发起。如果建立连接失败，重复发起连接，每次间隔 30 秒。登录校验：连接建立成功后
5、，client 发送“连接请求”包到 MAS 进行身份校验。注意，每个 API 只支持单连接，不支持多连接。校验响应：如果验证成功，用户可以进行发送消息、接收状态报告、或者 MO 的操作。如果校验失败，则发送失败响应包后主动断开连接，client 收到失败响应包后也随之断开连接。如果校验成功，则发送成功响应包。发送消息：在 client 收到 Mas 登录成功响应包后，client 就开始发送 submit 消息。要求每包号码记录不超过 100 个，如果需要发送的号码过多，则进行多次上传。MO：建立连接后，可接收 MO 信息，如果等待 10 秒能未有消息获得，断开连接，等待下次继续请求获取。状
6、态报告：建立连接后，可接收状态报告信息，如果等待 10 秒能未有消息获得，断开连接，等待下次继续请求获取。请求拆除连接：发送消息、MO 接收、状态报告接收完成后，要求主动断开连接。2.2 本协议中涉及的端口号端口号 应用7301 MAS 侦听端口，client 连接该端口Mas 移动信息机 SOCKETAPI 协议 1.0 开发手册63 消息定义3.1 基本数据类型Unsigned Integer 无符号整数3.2 消息结构项目 说明Message Header 消息头(所有消息公共包头 )Message Body 消息体3.3 消息头格式（ Message Header）字段名 字节数 类型
7、 描述Total_Length 4 Unsigned Integer消息总长度(含消息头及消息体)Command_Id 4 Unsigned Integer命令或响应类型Sequence_Id 4 Unsigned Integer消息流水号,顺序累加,步长为 1,循环使用（一对请求和应答消息的流水号必须相同）Version 1 Unsigned Integer协议版本，目前版本填 1Reserved 1 Unsigned Integer保留字段，方便以后扩充，比如是否采用压缩加密等3.4 client 与 MAS 间的消息定义client 向作为服务器端的 MAS 发起连接请求，只有在通过身份
8、验证之后通过 client 才能与 MAS 之间进行业务数据传输。每个请求都有一个相应的应答返回。3.4.1连接请求（CONNECT）客户端与服务器端建立连接Mas 移动信息机 SOCKETAPI 协议 1.0 开发手册73.4.1.1 CONNECT (client MAS)Command_Id: CONNECT0username1234字段解释：apicode：api 编码，对应 MAS 接口新增的接口编码。encrypttype：密码加密类型，0 位不加密，1 为我们选定的加密方式，其他数字留与扩展usr：接口创建时的接口登录名pwd：接口创建时的接口登录密码3.4.1.2 CONNEC
9、T_RESP (MASclient)Command_Id: CONNECT_RESP0正确 字段解释：Res: 结果 0：正确 1：其他错误Comment: 具体错误描述Mas 移动信息机 SOCKETAPI 协议 1.0 开发手册83.4.2发送消息(SUBMIT)服务器客户端处理模块发出消息请求，并返回消息应答，需要注意的是发送的内容长度将不超过 260 个文字( 一个英文字母也算是一个字)3.4.2.1 SUBMIT (client MAS)Command_Id: SUBMIT字段解释：apicode：api 编码，对应 MAS 接口新增的接口编码。sm_id：短信 ID，0 到 999
10、99999 中的某一整数。确保唯一后可以用来找到对应的回执、回复.content：短信内容,内容不超过 260 个汉字（当是 WAP PUSH 短信时，该字段意思为title，即 WAP PUSH 短信的标题）url:wap push 短信的 url 地址。 如果 url 不为空则该短信为 WAP PUSH 短信,为空表示该短信是普通短信。URL 不需要加“http:/ ”前缀。Mobile：手机号码，包括移动、联通、小灵通号码。号码前不需要加 86，小灵通号码格式为“区号+号码” ，如 075512345678。每个包体可以包含多个手机号码，但是每个包最大请不要超过 100 个号码。注意：W
11、AP PUSH 短信 URL 不能大于 110 字节，url 和内容总长不能超过 120 字节。如果 url 超过 110 字节，则 MAS 接收后可能做异常处理不予发送，如果总长超过 120 字节，则发送时标题内容将被截取。Mas 移动信息机 SOCKETAPI 协议 1.0 开发手册93.4.2.2 SUBMIT_RESP (MASclient)Command_Id: SUBMIT_RESP0正确 字段解释：Res: 结果 0：正确 1：其他错误Comment: 具体错误描述3.4.3MO(DELIVER)UMS 根据 ISMG 传来的 MO 消息，根据 corp_id，把此 MO 转发给
12、相应的客户端3.4.3.1 DELIVER (MASclient)Command_Id: DELIVER字段解释：mobile：发送短信的手机号码sm_id：MO 短信的短信 IDcontent：短信内容Mas 移动信息机 SOCKETAPI 协议 1.0 开发手册103.4.3.2 DELIVER_RESP (clientMAS)Command_Id: DELIVER_RESP0正确 3.4.4状态报告（REPORT ）状态报告,根据状态报告可判断最终用户是否接收到前提交的短消息3.4.4.1 REPORT (MASclient)Command_Id: REPORT3.4.4.2 REPOR
13、T_RESP(clientMAS)Command_Id: REPORT_RESPMas 移动信息机 SOCKETAPI 协议 1.0 开发手册110正确 3.4.5client 或 MAS 请求拆除连接（TERMINATE）TERMINATE 操作的目的是 client 或 MAS 基于某些原因决定拆除当前的应用层连接而发起的操作。此操作完成后 client 与 MAS 之间的应用层连接被释放，此后 client 若再要与 MAS通信时应发起 ONNECT 操作。client 或 MAS 以 TERMINATE_RESP 消息响应请求。3.4.5.1 TERMINATE 消息定义（client
14、MAS 或 MAS client）无消息体。3.4.5.2 TERMINATE_RESP 消息定义（client MAS 或 MAS client）无消息体。3.5 系统定义3.4.6Command_Id 定义消息 Command_Id值说明CONNECT 0x00000001 请求连接CONNECT_RESP 0x80000001 请求连接应答TERMINATE 0x00000002 终止连接Mas 移动信息机 SOCKETAPI 协议 1.0 开发手册12TERMINATE_RESP 0x80000002 终止连接应答SUBMIT 0x00000004 提交短信SUBMIT_RESP 0x
15、80000004 提交短信应答DELIVER 0x00000005 短信下发DELIVER_RESP 0x80000005 下发短信应答REPORT 0x00000006 状态报告REPORT_RESP 0x80000006 状态报告应答3.5.1 错误码使用说明对于错误码的处理，0 始终表示成功，其他表示失败，具体错误代码见附录的错误列表。3.4.7XML 的解析方式XML 的解析基本上分为 SAX 和 DOM 方式，SAX 方式有效率高但是代码稍复杂的缺点，DOM 方式效率低但代码量少，直观，考虑到系统的性能及以后 XML 可能包含多业务的情况，在服务器端将采用 SAX 方式。4 附录4.
16、1 错误列表4.1.1 登录响应（ CONNECT_RESP）错误代码 描述10101 消息结构错10102 非法的 APICODE10103 用户名密码错误10104 版本不对10105 系统忙，暂时不能登录10106 该 apicode 已被其他 API 使用Mas 移动信息机 SOCKETAPI 协议 1.0 开发手册1310107 API 服务暂停10112 重复登录10112-10120 保留发送消息响应（SUBMIT_RESP）错误代码 描述10121 消息结构错10122 消息序号重复10123 消息长度错10124 信息超过最大长度（280 个字）10127 企业发送队列满，不能发送（可以重发）10128 信息非法，含有关键字10129 非法号码（属于过滤号码）10130 目标号码错（指手机号码不足 11 位或者不同运营商号码）10131 手机号码数量不能超
