短信HTTP接口文档.doc

阅信短信HTTP接口文档

北京金楼世纪科技有限公司
2016年03月
目录
1. 概述 3
名词定义 3
工作方式 3
字符编码 3
计费方式 3
2. 下行消息 4
提交参数说明 4
返回值说明 4
返回内容示例 5
3. 上行消息&状态报告 6
上行消息参数说明 6
短信状态报告参数说明 6
语音状态报告参数说明 6
返回值 7
4. 余额查询 8
提交参数说明 8
返回参数说明 8
返回内容示例 8
5. 上行消息&状态报告主动查询 9
提交参数说明 9
返回参数说明 9
返回内容示例 9
6. 附录A 11
概述
本接口规范定义了短信系统(服务方)与客户系统(客户方)之间的数据传输协议及使用方法。通过这个接口规范可以实现客户系统(通过短信系统)与手机终端之间的消息传送。
名词定义
下行消息
下行消息又称MT消息,是指由业务系统送到短信平台,再转发到运营商的网关,并最终发送到手机终端上的文字信息。
上行消息
上行消息又称MO消息,是指由手机终端发送至短信短信平台并最终送到客户系统的文字信息。
状态报告
状态报告是一条特殊上行消息,用于报告下行消息的投递情况。即消息被送达到手机终端后返回的消息。并不是每一条下行消息都会有对应的状态报告。
工作方式
双方通过HTTP方式交互数据,可以简单的“name=value”方式发送提交内容或响应请求内容。即通过HTTP的GET/POST方式交换。
字符编码
关于短消息内容,服务端发送和接收数据均以UTF-8编码和解码。
计费方式
短短信:短信内容70字(含)以内,按70字1条计费。
长短信:短信内容70字以上,最大1000字,按67字1条计费。
下行消息
接口URL地址::9000/HttpSmsMt
提交方式:GET|POST(建议使用POST,批量提交用户必须使用POST)
提交参数说明
参数名称
参数说明
备注
name
帐号(必选)
pwd
密码(必选)
32位MD5小写值。
需要用给定的密码拼接发送时间进行再次MD5加密。MD5(pwd+mttime)
subid
扩展码(可选)
用户自定义的子用户接入号扩展码。
phone
手机号码(必选)
11位的有效手机号码。
群发多个手机号,用英文半角逗号“,”隔开,手机号最大个数为1000个。
content
短信内容(必选)
GET提交需要对内容进行URL编码。
Javascript提交需要对内容进行2次URL编码。
POST提交不需要对内容进行URL编码。
短信内容最长为1000个字符。
mttime
发送时间(必选)
时间格式:yyyyMMddhhmmss
extend
扩展字段(可选)
用户自定义扩展字段,推送状态报告时返回。
rpttype
返回数据类型(必选)
值为:1
返回值说明
参数名称
参数说明
备注
ReqCode
返回值
返回值,参见附录A
ReqMsg
返回值说明
返回值说明
ReqId
提交批次ID
匹配状态报告使用
返回内容示例
{
"ReqCode": "00",
"ReqMsg": "提交成功",
"ReqId": "20160101080000000123456"
}
上行消息&状态报告
用户提供接收上行消息和状态报告的URL地址,短信平台给用户及时推送上行消息和状态报告。上行消息和状态报告可共用1个URL地址,也可分开用2个URL地址。
状态报告需要用户根据下行消息时返回的ReqId和phone进行匹配。
上行消息参数说明
参数名称
参数说明
msgtype
0为上行消息
phone
手机号
subid
扩展号
content
上行短信内容
receivetime
上行消息接收时间,格式yyyyMMddHHmmss
短信状态报告参数说明
参数名称
参数说明
msgtype
2为状态报告
phone
手机号
reqid
ReqId发送批次ID
extend
用户自定义扩展字段,返回用户提交时的值。
receivetime
状态报告接收时间,格式yyyyMMddHHmmss
sendtime
短信下发时间,格式yyyyMMddHHmmss
state
状态报告码
语音状态报告参数说明
参数名称
参数说明
msgtype
2为状态报告