短信网关HTTP数据接口通讯协议(V0.1)

1、短信网关HTTP数据接口通讯协议(V0.1)文件状态： 草稿 正式发布 正在修改文件标识：当前版本：Version 0.1作者：彭凡联系方式完成日期：1 定义1.1 协议短信客户端与服务器端通过接口方式传输数据，传输协议为HTTP，每次由客户端发起请求，服务器端接收完请求并处理后，返回响应数据，并主动关闭连接。服务器端接口程序采用java开发，客户端由客户自行选择熟悉的方式。1.2 大小写说明如无特殊说明，则表示是大小写敏感的。A和a代表不同的含义。1.3 编码编码统一采用UTF-8。2 数据类型2.1 基本数据类型Integer整数String字符串，当未注明位数时，表示是可变长度；在明确注

2、明长度并位数不足的情况下，应左补齐。比如：String(6)表示占6个字节的字符串，当数据为1234时，应进行左补齐，补齐结果为：0012342.2 消息结构统一采用Json格式JSON结构体，例如name: ”zs” , password:”123”3 业务接口3.1 短信发送接口3.1.1 接口说明网关平台此时作为http server。商户系统向SP请求发送短信。用户可以一次发送多条数据。Msgtype的类型区别：1、 通知短信。网关发送失败后，通知短信会重新尝试发送。发送失败次数超过3次后，停止发送操作。2、 验证码短信。网关发送失败后，不会重新进行发送。3.1.2 Request （

3、command_id:A001） key:"" data: commandId:"" appid:"" appsecret:"" content:” phone message sendtimemsgidmsgtype ” 字段数据类型说明keyStringAES对称加密dataStringAES对称加密commandIdString每个接口唯一标识,例如：A001表示登录接口。详见每个接口appidString网关平台分配的商户appidappsecretString网关平台分配的商户appsecretconte

4、ntString消息体内容phoneString电话messageString短信内容sendtimeString发送时间。时间的毫秒数：1399176571278;msgidString商户系统可以唯一短信的字段msgtypeString类型。1、通知短信；2、验证码短信。3.1.3 Response （command_id:B001） commandIdcontent: status字段数据类型说明commandIdString每个接口唯一标识,例如：A001表示登录接口。详见每个接口contentString消息体内容statusString结果状态3.2 短信回执查询接口3.2.1 接

5、口说明商户系统主动请求SP系统接口，获取Sp在发送短信成功后，网关的回执信息。3.2.2 Request (command_id:A004) key:"" data: commandId:"" appid:"" appsecret:"" content:” msgid ” 字段数据类型说明keyStringAES对称加密dataStringAES对称加密commandIdString每个接口唯一标识,例如：A001表示登录接口。详见每个接口appidString网关平台分配的商户appidappsecretStri

6、ng网关平台分配的商户appsecretcontentString消息体内容msgidString多个逗号隔开3.2.3 Response (command_id:B004) commandIdcontent: status：data：msgidphonestatussendtimestat字段数据类型说明commandIdString每个接口唯一标识,例如：A001表示登录接口。详见每个接口contentString消息体内容statusString结果状态dataStringmsgidStringphoneStringstatusString是否成功。1、成功；2、失败sendtimeLo

7、ngstatString运营商返回的描述信息3.3 状态报告查询接口3.3.1 接口说明商户系统主动请求sp系统接口，获取网关返回的状态报告。3.3.2 Request (command_id:A005) key:"" data: commandId:"" appid:"" appsecret:"" content:” msgid ” 字段数据类型说明keyStringAES对称加密dataStringAES对称加密commandIdString每个接口唯一标识,例如：A001表示登录接口。详见每个接口appidS

8、tring网关平台分配的商户appidappsecretString网关平台分配的商户appsecretcontentString消息体内容msgidString多个逗号隔开3.3.3 Response (command_id:B005) commandIdcontent: status：data：msgidphonestatusstatreceivetime submittimedonetime字段数据类型说明commandIdString每个接口唯一标识,例如：A001表示登录接口。详见每个接口contentString消息体内容statusString结果状态dataStringmsgi

9、dStringphoneStringstatusString状态报告状态；1、成功；2、失败statStringreceivetimeString运营商接受到短信时间submittimeString网关提交时间donetimeString运营商处理完成时间3.4 上行短信查询接口3.4.1 接口说明：商户系统主动请求sp系统接口，获取网关返回的上行短信信息。3.4.2 Request (command_id:A007) key:"" data: commandId:"" appid:"" appsecret:""

10、content:” begindate enddate limit ” 字段数据类型说明keyStringAES对称加密dataStringAES对称加密commandIdString每个接口唯一标识,例如：A001表示登录接口。详见每个接口appidString网关平台分配的商户appidappsecretString网关平台分配的商户appsecretcontentString消息体内容begindateString开始时间yyyyMMddHHmmssenddateString结束时间yyyyMMddHHmmsslimitInt查询条数3.4.3 Response (command_id:B007) commandIdcontent: status：data：receiveidphonemsgsendtimedestid字段数据类型说明commandIdString每个接口唯一标识,例如：A001表示登录接口。详见每个接口contentString消息体内容statusString结果状态dataStringreceiveidString网关唯一标示phoneStringmsgString短信内容sen