[TOC]
协议说明
用户在遵循HTTP协议的前提下，可通过GET和POST方式提交短信发送请求(点对点发送短信只支持POST)。
短信可以提交不超过10000个手机号码，每个号码用英文逗号间隔。
注意：一次提交发送超过200个手机号码，请使用POST请求
注意：使用POST请求时请将数据放在请求体(body)中
短信发送请求地址
| 环境 | HTTP请求地址 |
|---|---|
| 正式环境 | http://IP:18002/send.do |
注意：接入之后最好向管理员申请ip地址绑定，这样能防止被恶意尝试造成账号泄露或被锁定；（密码连续错误10次将被锁定）
注意：header中的Content-Type必须为application/x-www-form-urlencoded！！！
短信发送请求参数
| 参数名 | 是否必须 | 说明 |
|---|---|---|
| uid | 必填 | 用户ID |
| pw | 必填 | 当有tm时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=4614&pw=md5(接口密码+tm)&mb=13900000001&ms=【测试】测试&tm=20200514112549
短信发送响应返回值
| 返回值 | 说明 | 解决方法 |
|---|---|---|
| 批次号 或 0,批次号 | 发送成功,批次号(例如：1112090856000110或0,1112090856000110) | ----- |
| -1 | uid或密码为空 | 确认用户名和密码是否填写 |
| -2 | 下发号码为空 | 填写下发号码 |
| -3 | 下发内容为空 | 填定规范的短信内容 |
| -4 | 内容超长 | 缩减短信字数 |
| -5 | 下发号码超长 | 确认号码是否正确 |
| -6 | uid或密码不正确 | 确认用户名和密码是否正确 |
| -7 | 余额不足 | 联系铁布衫客服充值 |
| -8 | ip鉴权未通过 | 联系铁布衫客服绑定IP地址 |
| -9 | 协议类型不对 | 确认协议 |
| -99 | 系统异常 | 联系铁布衫客服 |
点对点发送请求地址
| 环境 | HTTP请求地址 |
|---|---|
| 正式环境 | http://IP:18002/sendm.do |
注意：接入之后最好向管理员申请ip地址绑定，这样能防止被恶意尝试造成账号泄露或被锁定；（密码连续错误10次将被锁定）
注意：header中的Content-Type必须为application/json！点对点发送短信只支持POST！
点对点发送请求参数
| 参数名 | 是否必须 | 说明 |
|---|---|---|
| uid | 必填 | 用户ID |
| pw | 必填 | 当有tm时pw值为md5(接口密码+tm)，没有则是接口密码。（注：中间的+号在实际赋值时不要填写） |
| data | 必填 | data值为数组，数组由多个{“mb”:“手机号(一个)”,“ms”:“内容”}对象组成 |
| dm | 选填 | 定时时间，格式：yyyyMMddHHmmss |
| ex | 选填 | 发送扩展号，对于可扩展的通道，可以根据需要任意扩展，但发送出去总长度不会超过20位。 |
举例：地址 http://IP:18002/send.do --- body {"uid":4614,"pw":"md5(接口密码+tm)","data":[{"mb":"13900000001","ms":"测试【测试】"}],"tm":"20200514112549"}
点对点发送响应返回值(JSON)
| 参数名 | 说明 |
|---|---|
| status | 0 发送成功、-1 uid或密码为空、-2 下发号码为空、-3 下发内容为空、-4 内容超长、-5 下发号码超长、-6 uid或密码不正确、-7 余额不足、-8 ip鉴权未通过、-9 协议类型不对、-99 系统异常 |
| ret | ret值为数组，数组由多个{“mb”:“手机号(一个)”,“id”:“批次号”}对象组成 |
接收状态报告格式(POST)
<table>
<thead>
<tr>
<th>参数</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>data</td>
<td>内容为id,mb,st|id,mb,st|id,mb,st（id,mb,st为一条，多条用|分割）</td>
</tr>
</tbody>
</table>
- 注意：接收状态报告的地址由接入方提供，通道方把状态报告（批次号、手机号码、状态）的数据传给此地址
短信状态请求参数(POST)
<table>
<thead>
<tr>
<th>参数</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>批次号</td>
</tr>
<tr>
<td>st</td>
<td>短信状态报告，stat=DELIVRD表示用户成功接收短信。</td>
</tr>
<tr>
<td>mb</td>
<td>手机号码</td>
</tr>
</tbody>
</table>
举例：data=1112090856000110,13900000001,DELIVRD|1112090856000111,13900000002,DELIVRD|1112090856000112,13900000003,DELIVRD
接收短信上行参数(GET)
<table>
<thead>
<tr>
<th>参数</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>mb</td>
<td>手机号</td>
</tr>
<tr>
<td>sc</td>
<td>特服号</td>
</tr>
<tr>
<td>ms</td>
<td>内容（utf8编码）</td>
</tr>
</tbody>
</table>
举例：mb=13900000001&sc=10690001&ms=你好，测试
- 注意：由合作方提供的接收上行的地址，通道方把用户回复的短信数据（手机号、特服号、内容）传给此地址
查询余额请求地址(POST)
| 环境 | HTTP请求地址 |
|---|---|
| 正式环境 | http://IP:18005/balance.do |
- 注意：接入之后最好向管理员申请ip地址绑定，这样能防止被恶意尝试造成账号泄露或被锁定；（密码连续错误10次将被锁定）
查询余额请求参数(GET)
| 参数名 | 是否必须 | 说明 |
|---|---|---|
| uid | 必填 | 用户ID |
| pw | 必填 | 当有tm时pw值为md5(接口密码+tm)，没有则是接口密码。（注：中间的+号在实际赋值时不要填写） |
| tm | 必填 | 当前时间，格式：yyyyMMddHHmmss，共14位，tm设置为当前时间，与标准时间误差不能超过10分钟。 |
查询余额响应返回值(GET)
<table>
<thead>
<tr>
<th>参数</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr>
<td>直接返回余额数字</td>
<td>余额查询成功 例如：896452
</td>
</tr>
<tr>
<td>-1</td>
<td>用户不存在</td>
</tr>
<tr>
<td>-2</td>
<td>错误次数太多了</td>
</tr>
<tr>
<td>-3</td>
<td>uid或密码不正确</td>
</tr>
<tr>
<td>-4</td>
<td>ip鉴权未通过</td>
</tr>
</tbody>
</table>
强力驱动