《简版http协议接口文档.20150407》由会员分享，可在线阅读，更多相关《简版http协议接口文档.20150407（16页珍藏版）》请在金锄头文库上搜索。
1、HTTP 短信接口规范v1.22015 年 3 月文档变更记录序号 变更内容说明 版本号 版本日期 执笔人1初稿,基本协议，MT、MO、状态报告、查询余额下行为了兼容 cmpp 协议的长短信，数据短信，计费，服务代码等功能，字段设置以 cmpp 协议为蓝本，协议保留 cmpp 协议的所有功能1.0 2014/12/212简化版本修订：1. 抽取协议统一请求格式2. 增加简化 MO、MT3. 版本修订为 HIF1.11.1 2015/3/13极度简化版本：1. 鉴权方式改变，使用参数 userid， password2. MT 采用 http POST3.1.2 2015/3/164修改 MT
2、的 mobile 字段，从 String变为逗号分隔的String，但 MT 响应仍保持 Rets 数组形式1.2 2015/3/193 正式稿 1.1 2015/3/16目录1 概述 .31.1 协议说明 .31.2 适用范围 .31.3 参考资料 .31.4 缩略语 .32 通信方式 .33 协议报文定义 .33.1 报文域属性说明 .33.2 消息报文定义 .43.2.1 下行短信提交 MTSMSSUBMIT.43.2.2 查询当前预付费用户余额 QUERYAMTF .63.2.3 上行 URL 验证 MOURLVERIFY .73.2.4 上行短信推送 MOSMSPUSH .73.2.
3、5 上行状态报告推送 RPTPUSH.84 附录-码表 .94.1 认证返回码 authstatus.94.2 下行短信提交响应码 mtrespcode.94.3 查询余额响应码 queryamtfrespcode .94.4 上行接收响应码 morespcode.104.5 状态报告 Stat.101 概述1.1 协议说明本短信 API 是使用 HTTP 并遵循 REST 原则设计的 Web 服务接口，可以使用几乎任何客户端和任何编程语言与 REST API 进行交互。通过发送简单的 HTTP POST 请求就可以轻松接入使用。 1.1 版本说明在作为 CMPP 变体的 http 协议 ch
4、if1.0 推出后，为了简化协议开发难度，对协议的下行和上行部分进行相应地修改，形成本简化协议，保留业务逻辑必要的核心字段，去掉扩展功能的若干字段（本接口不再具备发送数据短信能力） 。1.1 与 chif1.0 的异同：1. 安全认证方式相同，仍然为报文头携带 Authorization 信息 base64 编码，URL 携带 MD5 token2. 下行 MTSMSSubmit/上行 MOSmsPush 报文简化3. 状态报告推送方式保持不变4. MO/MT 短信内容传递方式不使用 Byte,而是使用 Base64 编码的原始 UTF-8 字符串进行传递。1.2 适用范围1.3 参考资料 H
5、TTP 1.01.4 缩略语缩写 全称 说明EC Enterprise customer 企业客户MT Mobile Terminal 短信下行MO Mobile Original 短信上行2 通信方式HTP RSP HTPS REQ (GET/POST/PUT/DELTE) CLIENT SERV 通信支持 HTTP / HTTPS。其中 MT/QUERYAMTF 报文为 EC 作为 client 请求平台MOURLVERIFY/SMSMOPUSH/SMSRPTPUSH 报文为平台作为客户端请求 EC3 协议说明3.1 报文域属性说明元素约束（出现次数）符号说明：符号 说明? 0.1，可选项
6、* 0.n，可以没有，也可以有多项+ 1.n，至少有 1 项，也可以有多项1 必须有且只有 1 项3.2 EC 请求平台（下行）统一格式3.2.1 平台 Base URL由平台提供http:/IP:port/version属性 约束 类型 描述IP 1 String 平台的 IP 地址或者域名。port 0 Integer 端口号，端口号不为 80 时，与 IP 用半角:隔开当端口号为 80 时，此字段可空version 1 String 协议版本，当前协议版本为：HIF12BaseURL 示例：http:/192.168.1.1:8080/HIF12/http:/api.pro- 业务 UR
7、L 格式注：Base URL 与业务 URL 相拼接为完整请求 URL帐号鉴权：/funcion/Userid举例：下发短信息的 url 为：http:/api.pro-:28080/HIF12/mt用户 user0001 查询账户余额的 url 为：http:/api.pro-:28080/HIF12/ queryamtf/user0001属性 约束 类型 描述func 1 String 业务功能Userid 0 String 用户 ID3.2.3 HTTP 标准包头字段包头必填字段：Accept:application/json;Content-Type:application/json;
8、charset=utf-8; Content-Length:length; 属性 约束 类型 描述Accept 1 String 客户端响应接收数据格式： application/jsonContent-Type 1 String 类型： application/json;charset=utf-8Content-Length 1 String 内容长度3.3 平台做客户端请求 EC（上行）统一格式适用于平台作为客户端向 EC 发送上行、状态报告时的情形3.3.1 客户提供上行 Base URL由 EC 提供用以接收上行消息和状态报告的 Base URL举例：EC 提供上行 BaseURL 为
9、：http:/192.168.1.1:1459/serv/3.3.2 上行业务完整 URL上行各业务都有各自的 function，完整的业务 URL 会发送至：$客户提供上行 BaseURL /function举例：EC 提供上行 BaseURL 为：http:/192.168.1.1:1459/serv.php/平台上行短信 function 为 smsmopush, 上行报文会发送至：http:/192.168.1.1:1459/serv.php/smsmopush/平台状态报告 function 为 smsrptpushhttp:/192.168.1.1:1459/serv.php/smsrptpush/3.4 编码编码统一使用 UTF-84 协议报文定义4.1 消息报文定义4.1.1 下行短消息4.1.1.1提交 短信HTTP 方法 URL 描述POST $baseurl/mt/ 参见 3.2 节说明消息体 约束 类型 描述UseidUserid 1 String 用户 ID 账号 IDPasswd 1 String 帐号密码：(可以明文密码或使用32 位 MD5 加密)Cli_Msg_Id ? String(24) 客户流水号，可在响应中携带返回
