欢迎来到天天文库
浏览记录
ID:35398046
大小:68.05 KB
页数:11页
时间:2019-03-24
《短信网关socket数据接口通讯协议(v01)》由会员上传分享,免费在线阅读,更多相关内容在工程资料-天天文库。
1、短信网关数据接口通讯协议(V0.1)文件状态:[]草稿[]正式发布[V]正在修改文件标识:当前版本:Version0.1作者:彭凡联系方式完成日期:1定义1.1协议感信客户端■服务器端通过接口方式传输数据,传输协议为TCP短连接,每次由客户端发起请求,服务器端接收完请求并处理后,返回响应数据,并主动关闭socket连接。服务器端接口程序采用java开发,客户端由客户口行选择熟悉的方式。1.2大小写说明如无特殊说明,则表示是大小写敏感的。A和a代表不同的含义。1.3编码编码统•釆用UTF-8o2数据类型2.1基本数据类型Integer整数,
2、占4个字节String字符串,当未注明位数吋,表示是可变长度;在明确注明长度并位数不足的情况下,应左补齐。比如:String©)表示占6个字节的字符串,当数据为1234吋,应进行左补齐,补齐结果为:001234JsonJSON结构体,例如{name:"zs",password:''】23"}2.2消息结构221请求消息结构(MessageRequest):字段字节数数据类型说明Total」ength4UnsignedInteger紧跟随的request_body的长度orequest_body是json格式。长度不足6为左补零。假设req
3、uest_body长度为1234,则左补零为001234o服务器端读取到001234后,首先会去掉00,得到1234,然后再从socket中读収1234个字节,并转成字符串。该字符串是个json格式。Command_Id4String每个接口唯一标识,例如:A001表示登录接口。详见每个接口appid15Stringappsecret15Stringrcqucst_bodyJson具体的请求参数,为json格式。该json的字节为data_length0毎个接口的request_body都不一样。具体参数会在每个接口中详述。2.2.2响应
4、消息结构(MessageResponse):字段字节数数据类型说明Total_length4UnsignedInteger紧跟随的request_body的长度。request_body是json格式。长度不足6为左补零。假设rcqucst_body长度为1234,则左补零为001234。服务器端读取到001234后,首先会去掉00,得到1234,然后再从socket中读取1234个字节,并转成字符串。该字符串是个json格式。Command_Id4String⑷每个接口唯一标识,例如:A001表示登录接口。详见每个接口responseb
5、odyJson具体的响应消息参数,为json格式。详见下表。3业务接口3.1短信发送接口3.1.1接口说明网关平台此时作为socketserver0商八系统向SP请求发送短信。用户可以一次发送多条数据。Msgtype的类型区别:1、通知短信。网关发送失败示,通知短信会重新尝试发送。发送失败次数超过3次后,停止发送操作。2、验证码翹信。网关发送失败后,不会重新进行发送。3.1.2request_body(commanded:A001)phonemessagesendtimemsgidmsgtype]}字段数据类型说明phoneStringm
6、essageString短信内容sendtimeString发送时间。时间的毫秒数:1399176571278;msgidString商户系统可以唯一如信的字段msgtypeString类型。1、通知短信;2、验证码短信。3.1.2response_body(command_id:B001)status}字段数据类型说明statusString3.2短信回执推送接口321接口说明网关平台发送短信成功后,获収运营返回的回执信息,主动将回执信息推送到商户系统。网关平台此时作为socketservero超过60秒后,server没冇收到resp
7、onse_body,系统将会重新发送回执信息。发送三次后,系统认为信息发送完成,不在进行发送。3.2.2request_body(command_id:A002)msgidphonestatussendtimestat]}字段数据类型说明msgidStringphoneStringstatusString是否成功。1、成功;2、失败sendtimeLongstatString运营商返回的描述信息323response_body(commanded:B002):3.3短信状态报告推送接口3.3.1接口说明网关平台发送短信成功后,获取运营返回
8、的短信状态报告信息,主动将信状态报告倍息推送到商户系统。网关平台此时作为socketservero超过60秒后,server没冇收到response_body,系统将会重新发送回执信息。发送三
此文档下载收益归作者所有