秒推-接入指南

1 短信发送接口（相同内容群发）

1.1 请求地址

http://sms.miaotui.cn:8001/std/sms

1.2 请求方式

HTTP POST

1.3 请求参数

名称	数据类型	长度	说明
account	String	10	用户账号
timestamp	String	20	时间戳，当前时间与协调世界时 1970 年 1 月 1 日午夜之间的时间差（以毫秒为单位测量）。调用超时时间为三分钟（即本次调用时间需在上一次调用前三分钟内）多进程调用，请注意控制。单位：毫秒
access_token	String	32	调用平台能力接口的鉴权信息，生成规则为：md5(timestamp+password)其中password是用户密匙
receiver	String	6000	接收手机号码，最多500个；多个手机号码，中间间隔用英文逗号。事例： 13800000000或者13800000000,13800000001 支持号段：130-139、145-147、150-153、155-159、180-189、170-178、其他新增号段
smscontent	String	2000	短信内容，最大中文长度700个汉字，1400个字节编码采用UTF-8编码形式 java.net.URLEncoder(content,“UTF-8”)
extcode	String	6	扩展码,用于构造下发短信通道尾号例:主通道为10690555 扩展码为:9 手机收到显示通道号为: 106905559 不扩展填写空

重要说明：为提供发送效率，相同信息内容的号码一定要打包发送，一次可以发送500个号码。

参数实例：

account ="us001";

timestamp=1521212212178

password="123456 ";

access_token =md5("1521212212178"+"123456");

receiver ="13800000000";

smscontent ="测试";

extcode=”9”;

完整示例：

account=us001×tamp=1521212212178&access_token=A80F939E659A2C46CEE05FFA6981BB52&receiver=13800000000&smscontent=测试&extcode=9

1.4 返回结果

名称	数据类型	长度	说明
res_code	String	2	同步结果代码：0：表示成功， 1：调用失败， 2：鉴权失败, 3：关键字其它值均表示失败
res_message	String	512	成功返回：Success；错误返回：错误信息
identifier	String	20	成功返回：短信唯一标识；错误返回：返回空

1.5 返回格式

JSON

参数实例：

res_code:0

res_message:Success

identifier:2663

完整实例：

{'res_code':'0',

'res_message':'Success',

identifier:'2683'}

2 短信发送接口(不同内容群发)

2.1 请求地址

http://sms.miaotui.cn:8001/std/multiSms

2.2 请求方式

HTTP POST

2.3 请求参数

名称	数据类型	长度	说明
account	String	10	用户账号
timestamp	String	20	时间戳，当前时间与协调世界时 1970 年 1 月 1 日午夜之间的时间差（以毫秒为单位测量）。调用超时时间为三分钟（即本次调用时间需在上一次调用前三分钟内）多进程调用，请注意控制。单位：毫秒
access_token	String	32	调用平台能力接口的鉴权信息，生成规则为：md5(timestamp+password)其中password是用户密匙
receiver	String	11	接收手机号码，单个；多个手机号码，中间间隔用英文逗号。事例： 13800000000或者13800000000,13800000001 支持号段：130-139、145-147、150-153、155-159、180-189、170-178、其他新增号段
receiver	String	11
receiver	String	11
…	…	…	…第n个号码，最多500个
smscontent	String	2000	对应第三个手机号码接收短信内容，最大中文长度700个汉字，1400个字节编码采用UTF-8编码形式 java.net.URLEncoder(content,“UTF-8”)
smscontent	String	2000
smscontent	String	2000
…	…	…	…对应第n个号码短信内容，最多500个
extcode	String	6	扩展码,用于构造下发短信通道尾号9 例:主通道为10690555 扩展码为:99 手机收到显示通道号为: 106905559 不扩展填写空

重要说明：为提供发送效率，相同信息内容的号码一定要打包发送，一次可以发送500个号码。

参数实例：

account ="us001";

timestamp=1521212212178

password="123456 ";

access_token =md5("1521212212178"+"123456");

receiver ="13800000001";

receiver ="13800000002";

receiver ="13800000003";

smscontent ="测试1";

smscontent ="测试2";

smscontent ="测试3";

extcode=”9”;

完整实例：

account=us001×tamp=1521212212178&access_token=A80F939E659A2C46CEE05FFA6981BB52&receiver=13800000001&receiver=13800000002&receiver=13800000003&smscontent=测试1&smscontent=测试2&smscontent=测试3&extcode=9

2.4 返回结果

名称	数据类型	长度	说明
res_code	String	2	同步结果代码： 0：表示成功， 1：调用失败， 2：鉴权失败, 3：关键字其它值均表示失败
res_message	String	512	成功返回：Success；错误返回：错误信息
identifier	String	2000	成功返回：短信唯一标识1,短信唯一标识2, 短信唯一标识3…；错误返回：返回空

2.5 返回格式

JSON

参数实例：

res_code:0

res_message:Success

identifier:2663,2684,2685

完整实例：

{'res_code':'0',

'res_message':'Success',

identifier:'2683,2684,2685'}

3 短信状态查询接口

应用主动查询状态报告（根据identifier和手机号码）。

3.1 请求地址

http://sms.miaotui.cn:8001/std/status

3.2 请求方式

HTTP POST

3.3 请求参数

名称	数据类型	长度	说明
account	String	10	用户账号
timestamp	String	20	时间戳，当前时间与协调世界时 1970 年 1 月 1 日午夜之间的时间差（以毫秒为单位测量）。调用超时时间为三分钟（即本次调用时间需在上一次调用前三分钟内）多进程调用，请注意控制。单位：毫秒
access_token	String	32	调用平台能力接口的鉴权信息，生成规则为：md5(timestamp+password)其中password是用户密匙
identifier	String	20	短信唯一标识，成功调用“发送短信”接口时返回。可以为空
msisdn	String	11	接收手机号码可以为空。如果跟identifier同时为空，可以查询最近未获取的状态报告信息

参数实例：

account ="us001";

timestamp=1521212212178

password="123456 ";

access_token =md5("1521212212178"+"123456");

identifier="2664"

msisdn=”13800000000”

完整实例：

account=us001×tamp=1521212212178&access_token=A80F939E659A2C46CEE05FFA6981BB52&identifier=2664&msisdn=13800000000

3.4 返回结果

名称	数据类型	长度	说明
res_code	String	2	同步结果代码: 0：表示成功， 1：参数不正确， 2：鉴权失败, 3：未知状态其它值均表示失败
res_message	String	512	成功返回回执结果，每条回执按分号隔开，每个字段按逗号隔开，每条回执共包含3个字段，第1个字段为消息标识，第2个字段为被发送的手机号码，第3个字段为回执结果，0和DELIVRD表示成功，其他值表示失败其他为错误信息描述

实际返回内容为:“1,13000000000,0; 2,13500000000,0;3,15300000000,0;”
*注：回执信息在接口收到后只保存48个小时，48小时后将会清除，建议查询频次1分钟，接口单次查询返回的回执条数为1000.

3.5 返回格式

JSON

参数实例：

成功返回时：

res_code:0

res_message:‘1,13500000000,0’

失败返回时：

res_code:1

res_message:调用失败：参数不足！

完整实例：

成功返回时：

{'res_code':0,'res_message':'1,13500000000,0;2,13800000000,1'}

失败返回时：

{'res_code':1,'res_message':'调用失败：参数不足！'}

4 短信上行消息查询接口

应用主动查询上行消息（每次间隔大于30秒，否则返回为空）。

4.1 请求地址

http://sms.miaotui.cn:8001/std/mo

4.2 请求方式

HTTP POST

4.3 请求参数

名称	数据类型	长度	说明
account	String	10	用户账号
timestamp	String	20	时间戳，当前时间与协调世界时 1970 年 1 月 1 日午夜之间的时间差（以毫秒为单位测量）。调用超时时间为三分钟（即本次调用时间需在上一次调用前三分钟内）多进程调用，请注意控制。单位：毫秒
access_token	String	32	调用平台能力接口的鉴权信息，生成规则为：md5(timestamp+password)其中password是用户密匙

参数实例：

account ="us001";

timestamp=1521212212178

password="123456 ";

access_token =md5("1521212212178"+"123456");

完整实例：

account=us001×tamp=1521212212178&access_token=A80F939E659A2C46CEE05FFA6981BB52

4.4 返回结果：

名称	数据类型	长度	说明
res_code	String	2	同步结果代码: 0：表示成功， 1：参数不正确， 2：鉴权失败, 3：未知状态其它值均表示失败
res_message	String	512	成功返回回执结果，每条回执按分号隔开，每个字段按逗号隔开，每条回执共包含4个字段，第1个字段为手机号码，第2个字段为接收号码，第3个字段为发送时间，第4个字段为发送内容(内容采用UTF-8编码格式)，第5个字段为消息格式(15中文,4为二进制) 其他为错误信息描述

4.5 返回格式

JSON

参数实例：

成功返回时：

res_code:0

res_message:’13500000000,1065712345,2015-07-08 11:23:08,%32;15300000000,10657321,2015-07-09 15:32:09,%31,15’

失败返回时：

res_code:1

res_message:‘鉴权失败’

完整实例：

成功返回时：

{'res_code':0,'res_message'：’13500000000,1065712345,2015-07-08 11:23:08,%32;15300000000,10657321,2015-07-09 15:32:09,%31,15’}

失败返回时：

{'res_code':0,'res_message'：'鉴权失败'}

5 余额查询接口

应用主动查询余额消息（每次间隔大于30秒，否则返回为空）。

5.1 请求地址

http://sms.miaotui.cn:8001/std/balance

5.2 请求方式

HTTP POST

5.3 请求参数

名称	数据类型	长度	说明
account	String	10	用户账号
timestamp	String	20	时间戳，当前时间与协调世界时 1970 年 1 月 1 日午夜之间的时间差（以毫秒为单位测量）。调用超时时间为三分钟（即本次调用时间需在上一次调用前三分钟内）多进程调用，请注意控制。单位：毫秒
access_token	String	32	调用平台能力接口的鉴权信息，生成规则为：md5(timestamp+password)其中password是用户密匙

参数实例：

account ="us001";

timestamp=1521212212178

password="123456 ";

access_token =md5("1521212212178"+"123456");

完整实例：

account=us001×tamp=1521212212178&access_token=A80F939E659A2C46CEE05FFA6981BB52

5.4 返回结果

名称	数据类型	长度	说明
res_code	String	2	同步结果代码: 0：表示成功， 1：参数不正确， 2：鉴权失败, 3：未知状态其它值均表示失败
res_message	String	512	成功返回：余额信息（剩余短信发送量）；参数不正确：调用失败，参数不足！鉴权失败：失败信息

JSON

参数实例：

成功返回时：

res_code:0

res_message:99999

失败返回时：

res_code:1

res_message:‘鉴权失败’

完整实例：

成功返回时：

{'res_code':0,'res_message'：9999}

失败返回时：

{'res_code':1,'res_message'：'鉴权失败'}

0	成功
MT:1001	参数不完整
MT:1002	未包含签名
MT:1003	参数不合法
MT:1004	请求已过期
MT:1005	接收号码不能超过500个
MT:1006	接口号码为空
MT:1007	短信内容为空
MT:1008	短信内容超过700个字
MT:1009	短信内容包含非法敏感词
MT:1010	账号无效
MT:1011	用户鉴权失败
MT:1012	用户已经停用
MT:1013	用户IP鉴权失败
MT:1014	流量已经用完
MT:1015	流量不够，请充值
MT:1016	时间不被允许
MT:1017	无可用短信通道或者未匹配到签名
MT:1018	短信提交失败,其它错误
MT:1019	接收号码和接收内容个数不匹配