2022年短信网关socket数据接口通讯协议 .pdf

《2022年短信网关socket数据接口通讯协议 .pdf》由会员分享，可在线阅读，更多相关《2022年短信网关socket数据接口通讯协议 .pdf（11页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、短信网关数据接口通讯协议(V0.1)文件状态：草稿 正式发布 正在修改文件标识：当前版本：Version 0.1 作者：彭凡联系方式完成日期：1 定义1.1 协议短信客户端与服务器端通过接口方式传输数据，传输协议为TCP 短连接，每次由客户端发起请求，服务器端接收完请求并处理后，返回响应数据，并主动关闭socket 连接。服务器端接口程序采用java 开发，客户端由客户自行选择熟悉的方式。1.2 大小写说明如无特殊说明，则表示是大小写敏感的。A 和 a 代表不同的含义。1.3 编码编码统一采用UTF-8。名师资料总结-精品资料欢迎下载-名师精心整理-第 1 页，共 11 页 -2 数据类型2.

2、1 基本数据类型Integer 整数，占4 个字节String 字符串，当未注明位数时，表示是可变长度；在明确注明长度并位数不足的情况下，应左补齐。比如：String(6)表示占 6 个字节的字符串，当数据为1234 时，应进行左补齐，补齐结果为：001234 Json JSON 结构体，例如 name:”zs”,password:”123”2.2 消息结构2.2.1 请求消息结构（MessageRequest）：字段字节数数据类型说明Total_length 4 Unsigned Integer紧跟随的request_body 的长度。request_body 是 json 格式。长度不足

3、6为左补零。假设 request_body长度为 1234，则左补零为001234。服务器端读取到001234 后，首先会去掉 00，得到 1234，然后再从socket 中读取 1234 个字节，并转成字符串。该字符串是个json 格式。Command_Id 4 String 每个接口唯一标识,例如：A001 表示登录接口。详见每个接口appid 15 String appsecret15 String request_body Json 具体的请求参数，为json 格式。该json 的字节为data_length。每个接口的request_body 都不一样。具体参数会在每个接口中详述。名

4、师资料总结-精品资料欢迎下载-名师精心整理-第 2 页，共 11 页 -2.2.2 响应消息结构（MessageResponse）：字段字节数数据类型说明Total_length 4 Unsigned Integer紧跟随的request_body 的长度。request_body 是 json 格式。长度不足 6为左补零。假设 request_body长度为 1234，则左补零为001234。服务器端读取到001234 后，首先会去掉 00，得到 1234，然后再从socket 中读取 1234 个字节，并转成字符串。该字符串是个json 格式。Command_Id 4 String(4)每

5、个接口唯一标识,例如：A001 表示登录接口。详见每个接口response_body Json 具体的响应消息参数，为json 格式。详见下表。3 业务接口3.1 短信发送接口3.1.1 接口说明网关平台此时作为socket server。商户系统向SP请求发送短信。用户可以一次发送多条数据。Msgtype 的类型区别：1、通知短信。网关发送失败后，通知短信会重新尝试发送。发送失败次数超过3次后，停止发送操作。2、验证码短信。网关发送失败后，不会重新进行发送。3.1.2 request_body（command_id:A001）phone message sendtime msgid msgt

6、ype 字段数据类型说明名师资料总结-精品资料欢迎下载-名师精心整理-第 3 页，共 11 页 -phone String message String 短信内容sendtime String 发送时间。时间的毫秒数：1399176571278;msgid String 商户系统可以唯一短信的字段msgtype String 类型。1、通知短信；2、验证码短信。3.1.3 response_body（command_id:B001）status 字段数据类型说明status String 3.2 短信回执推送接口3.2.1 接口说明网关平台发送短信成功后，获取运营返回的回执信息，主动将回执信息

7、推送到商户系统。网关平台此时作为socketserver。超过 60 秒后，server 没有收到response_body，系统将会重新发送回执信息。发送三次后，系统认为信息发送完成，不在进行发送。3.2.2 request_body(command_id:A002)msgid phone status sendtime stat 字段数据类型说明名师资料总结-精品资料欢迎下载-名师精心整理-第 4 页，共 11 页 -msgid String phone String status String 是否成功。1、成功；2、失败sendtime Long stat String 运营商返回的描

8、述信息3.2.3 response_body(command_id:B002)：3.3 短信状态报告推送接口3.3.1 接口说明网关平台发送短信成功后，获取运营返回的短信状态报告信息，主动将信状态报告信息推送到商户系统。网关平台此时作为socketserver。超过 60 秒后，server 没有收到response_body，系统将会重新发送回执信息。发送三次后，系统认为信息发送完成，不在进行发送。3.3.2 request_body(command_id:A003)msgid phone status stat receivetime submittime donetime 字段数据类型说

9、明名师资料总结-精品资料欢迎下载-名师精心整理-第 5 页，共 11 页 -msgid String phone String status String 状态报告状态；1、成功；2、失败stat String receivetime Long 运营商接受到短信时间submittime String 网关提交时间yyMMddHHmmss donetime String 运营商处理完成时间yyMMddHHmmss 3.3.3 response_body(command_id:B003)：3.4 短信回执接口3.4.1 接口说明商户系统主动请求SP系统接口，获取 Sp在发送短信成功后，网关的回执信

10、息。网关平台此时作为socket client。3.4.2 request_body(command_id:A004)msgid：字段数据类型说明msgid String 多个逗号隔开名师资料总结-精品资料欢迎下载-名师精心整理-第 6 页，共 11 页 -3.4.3 response_body(command_id:B004)：status：data：msgid phone status sendtime stat 字段数据类型说明msgid String phone String status String 是否成功。1、成功；2、失败sendtime Long stat String 运

11、营商返回的描述信息3.5 状态报告回执接口3.5.1 接口说明商户系统主动请求sp 系统接口，获取网关返回的状态报告。网关平台此时作为socket client。3.5.2 request_body(command_id:A005)msgid：字段数据类型说明msgid String 名师资料总结-精品资料欢迎下载-名师精心整理-第 7 页，共 11 页 -3.5.3 response_body(command_id:B005)status：data：msgid phone status stat receivetime submittime donetime 字段数据类型说明msgid St

12、ring phone String status String 状态报告状态；1、成功；2、失败stat String receivetime String 运营商接受到短信时间submittime String 网关提交时间donetime String 运营商处理完成时间3.6 上行短信接口3.6.1 接口说明：网关平台此时作为socket client，将系统接收到的上行短信定时发送给商户系统，功商户系统处理业务3.6.2 request_body(command_id:A006)名师资料总结-精品资料欢迎下载-名师精心整理-第 8 页，共 11 页 -receiveid phone m

13、sg sendtime destid 字段数据类型说明receiveid String 网关唯一标示phone String msg String 短信内容sendtime Long 系统接受时间destid String 3.6.3 response_body(command_id:B006)3.7 上行短信查询接口3.7.1 接口说明：商户系统主动请求SP系统接口，获取上行短信。网关平台此时作为socket client。3.7.2 request_body(command_id:A007)nextId 3.7.3 response_body(command_id:B007)status：

14、nextId:data：名师资料总结-精品资料欢迎下载-名师精心整理-第 9 页，共 11 页 -receiveid phone msg sendtime destid 字段数据类型说明nextId String 下一次查询主键大于该id 的数据（如果没有符合条件数据直接返回请求的nextId）receiveid String 网关唯一标示phone String msg String 短信内容sendtime Long 系统接受时间destid String 3.8 心跳3.8.1 接口说明商户系统主动请求sp，返回心跳信息。3.8.2 request_body(command_id:A020)空3.8.3 response_body(command_id:B020)无名师资料总结-精品资料欢迎下载-名师精心整理-第 10 页，共 11 页 -4 错误码错误码说明备注1000 成功1000 1001 Appid 或者 appsecret 错误1001 1002 数据格式不正确1002 1003 商户短信流量不足（要充值）1003 1004 系统繁忙1004 1005 短信量超过最大发送阀值1005 1006 没有收到运营商回执信息或状态报告信息1006 名师资料总结-精品资料欢迎下载-名师精心整理-第 11 页，共 11 页 -