z
l 协议说明
用户在遵循HTTP协议的前提下,可通过GET和POST方式提交短信发送请求。
短信可以提交不超过10000个手机号码,每个号码用英文逗号间隔。
注意:一次提交发送超过200个手机号码,请使用POST请求
注意:使用POST请求时请将数据放在请求体(body)中
l 短信发送请求地址
环境 | HTTP请求地址 |
正式环境 | http://ip:18002/send.do |
注意:接入之后最好向管理员申请ip地址绑定,这样能防止被恶意尝试造成账号泄露或被锁定;(密码连续错误10次将被锁定)
注意:header中的Content-Type必须为application/x-www-form-urlencoded !!!
l 短信发送请求参数
参数 | 是否必填 | 描述 |
uid | 必填 | 用户ID |
pw | 必填 | pw值为md5(用户密码+tm)。(注:中间的+号在实际赋值时不要填写) |
mb | 必填 | 目的手机号,多条请用英文逗号隔开,最多10000个号码 |
ms | 必填 | 发送内容,请用utf8方式进行编码,最多1000个文字(1个英文或数字也算1个文字) |
tm | 必填 | 当前时间,格式:yyyyMMddHHmmss,共14位,tm设置为当前时间,与标准时间误差不能超过10分钟。 |
dm | 选填 | 定时时间,格式:yyyyMMddHHmmss |
ex | 选填 | 发送扩展号,对于可扩展的通道,可以根据需要任意扩展,但发送出去总长度不会超过20位。 |
举例:http://ip:18002/send.do?uid=7592&pw=md5(密码+tm)&mb=13900000001&ms=测试【测试】&tm=20190729141735
l 短信发送响应返回值
返回值 | 描述 |
批次号 或 0,批次号 | 发送成功,批次号(例如1112090856000110或0,1112090856000110) |
-1 | uid或密码为空 |
-2 | 下发号码为空 |
-3 | 下发内容为空 |
-4 | 内容超长 |
-5 | 下发号码超长 |
-6 | uid或密码不正确 |
-7 | 余额不足 |
-8 | ip鉴权未通过 |
-9 | 协议类型不对 |
-99 | 系统异常 |
l 接收状态报告格式(POST)
参数 | 描述 |
data | 内容为id,mb,st|id,mb,st|id,mb,st(id,mb,st为一条,多条用|分割) |
注意:接收状态报告的地址由接入方提供,通道方把状态报告(批次号、手机号码、状态)的数据传给此地址
l 短信状态请求参数(POST)
参数 | 描述 |
id | 批次号 |
st | 短信状态报告,stat=DELIVRD表示用户成功接收短信。 |
mb | 手机号码 |
举例:data=1112090856000110,13900000001,DELIVRD|1112090856000111,13900000002,DELIVRD|1112090856000112,13900000003,DELIVRD
l 接收短信上行参数(GET)
参数 | 描述 |
mb | 手机号 |
sc | 特服号 |
ms | 内容(utf8编码) |
注意:由合作方提供的接收上行的地址,通道方把用户回复的短信数据(手机号、特服号、内容)传给此地址
l 查询余额请求地址(POST)
环境 | HTTP请求地址 |
正式环境 | http://ip:18005/balance.do |
注意:接入之后最好申请ip地址绑定,这样能防止被恶意尝试造成账号泄露或被锁
l 查询余额请求参数(GET)
参数 | 描述 |
uid | 用户ID |
pw | pw值为md5(用户密码+tm)。(注:中间的+号在实际赋值时不要填写) |
tm | 当前时间,格式:yyyyMMddHHmmss,共14位,tm设置为当前时间,与标准时间误差不能超过10分钟。 |
l 查询余额响应返回值(GET)
返回值 | 描述 |
直接返回余额数字 | 余额 例如:169082 |
-1 | 用户不存在 |
-2 | 错误次数太多了 |
-3 | uid或密码不正确 |
-4 | ip鉴权未通过 |
-5 | 错误次数太多了 |
客服人员为您解疑答惑
咨询电话
400-995-1559关注微信公众号