欢迎来到天天文库
浏览记录
ID:8254819
大小:83.63 KB
页数:16页
时间:2018-03-13
《简版http协议接口文档.20150407》由会员上传分享,免费在线阅读,更多相关内容在应用文档-天天文库。
1、HTTP短信接口规范v1.22015年3月文档变更记录序号变更内容说明版本号版本日期执笔人1初稿,基本协议,MT、MO、状态报告、查询余额下行为了兼容cmpp协议的长短信,数据短信,计费,服务代码等功能,字段设置以cmpp协议为蓝本,协议保留cmpp协议的所有功能1.02014/12/212简化版本修订:1.抽取协议统一请求格式2.增加简化MO、MT3.版本修订为HIF1.11.12015/3/13极度简化版本:1.鉴权方式改变,使用参数userid,password2.MT采用httpPOST3.1.22015/3/164修改MT的mobile字段,从S
2、tring[]变为逗号分隔的String,但MT响应仍保持Rets数组形式1.22015/3/193正式稿1.12015/3/16目录1概述31.1协议说明31.2适用范围31.3参考资料31.4缩略语32通信方式33协议报文定义33.1报文域属性说明33.2消息报文定义43.2.1下行短信提交MTSMSSUBMIT43.2.2查询当前预付费用户余额QUERYAMTF63.2.3上行URL验证MOURLVERIFY73.2.4上行短信推送MOSMSPUSH73.2.5上行状态报告推送RPTPUSH84附录-码表94.1认证返回码authstatus94.2
3、下行短信提交响应码mtrespcode94.3查询余额响应码queryamtfrespcode94.4上行接收响应码morespcode104.5状态报告Stat101概述1.1协议说明本短信API是使用HTTP并遵循REST原则设计的Web服务接口,可以使用几乎任何客户端和任何编程语言与RESTAPI进行交互。通过发送简单的HTTPPOST请求就可以轻松接入使用。 1.1版本说明在作为CMPP变体的http协议chif1.0推出后,为了简化协议开发难度,对协议的下行和上行部分进行相应地修改,形成本简化协议,保留业务逻辑必要的核心字段,去掉扩展功能的若干字
4、段(本接口不再具备发送数据短信能力)。1.1与chif1.0的异同:1.安全认证方式相同,仍然为报文头携带Authorization信息base64编码,URL携带MD5token2.下行MTSMSSubmit/上行MOSmsPush报文简化3.状态报告推送方式保持不变4.MO/MT短信内容传递方式不使用Byte[],而是使用Base64编码的原始UTF-8字符串进行传递。1.2适用范围1.3参考资料•HTTP1.01.1缩略语缩写全称说明ECEnterprisecustomer企业客户MTMobileTerminal短信下行MOMobileOrigina
5、l短信上行2通信方式通信支持HTTP/HTTPS。其中MT/QUERYAMTF报文为EC作为client请求平台MOURLVERIFY/SMSMOPUSH/SMSRPTPUSH报文为平台作为客户端请求EC3协议说明3.1报文域属性说明元素约束(出现次数)符号说明:符号说明?0..1,可选项*0..n,可以没有,也可以有多项+1..n,至少有1项,也可以有多项1必须有且只有1项1.1EC请求平台(下行)统一格式1.1.1平台BaseURL由平台提供http://{IP}:{port}/{version}属性约束类型描述IP1String平台的IP地址或者域名
6、。port0Integer端口号,端口号不为80时,与IP用半角:隔开当端口号为80时,此字段可空version1String协议版本,当前协议版本为:HIF12BaseURL示例:http://192.168.1.1:8080/HIF12/http://api.pro-grouop.com/HIF12/1.1.2业务URL格式注:BaseURL与业务URL相拼接为完整请求URL帐号鉴权:/{funcion}/[Userid]举例:下发短信息的url为:http://api.pro-group.com:28080/HIF12/mt用户user0001查询账
7、户余额的url为:http://api.pro-group.com:28080/HIF12/queryamtf/user0001属性约束类型描述func1String业务功能Userid0String用户ID1.1.1 HTTP标准包头字段包头必填字段:Accept:application/json;Content-Type:application/json;charset=utf-8; Content-Length:length; 属性约束类型描述Accept1String客户端响应接收数据格式:application/jsonContent-Type1
8、String类型:application/json;charset
此文档下载收益归作者所有