助通-SMS短信平台(HTTP方式-推荐)接口开发文档
上海助通信息科技有限公司
SMS接口开发文档
V：20160508
目录
API接口说明 (1)
（HTTP方式）接口 (1)
1、普通短信 (2)
2、变量短信 (4)
3、余额查询 (6)
4、状态报告 (7)
5、回复内容接口 (9)
6、发送量数据报表提取 (12)
API接口说明
（HTTP方式）接口
1 / 13
1、普通短信
提交地址：https://www.wendangku.net/doc/2213658360.html,/sendNSms.do 接口提交方式：GET/POST
功能：发送短信
样例：
2 / 13
https://www.wendangku.net/doc/2213658360.html,/sendNSms.do?username=用户名&password=密码&tkey=20160324151338&mobile=手机号&content=此次登录验证码123456【助通科技】&productid=产品id&xh=
其中：content参数，采用下列方式处理：
// String content = "汉字";
// content = URLEncoder.encode(content, "UTF-8");
3 / 13
2、变量短信
一般变量提交地址：https://www.wendangku.net/doc/2213658360.html,/sendManyNSms.do（如果提交的是一个内容，SMS系统会按照单内容多号码方式提交）
接口提交方式：POST（get不支持大数据）
功能：发送短信
短信签名（重要）：如果用户发送的内容最后一个字符为“】”，默认为用户已经增加了签名，否则自动追加用户在平台中设置的签名到发送的内容最后。
格式：“【签名】”，系统自动追加的签名中，会自动增加“【】”，内容为用户设置的内容。一个内容中只能有一个签名。变量短信只支持单条多任务发送，不支持群发多任务发送
4 / 13
样例：
https://www.wendangku.net/doc/2213658360.html,/sendManySms.do?username=用户名&password=密码&tkey=20160324151338&mobile=手机号1,手机号2&content=短信1【签名】※短信2【签名】&productid=产品id&xh=
手机号与内容的条数必须相同，否则会发送失败。
其中：content参数，采用下列方式处理：
// String content = "汉字";
// content = URLEncoder.encode(content, "UTF-8");
5 / 13
3、余额查询
提交地址：https://www.wendangku.net/doc/2213658360.html,/balanceN.do
余额接口提交方式：GET/POST
功能：查询短信剩余数量
样例：
https://www.wendangku.net/doc/2213658360.html,/balanceN.do?username=userccc&password=XXXX&tk ey=2016xxxxxxxxxx
6 / 13
4、状态报告
状态报告接口提交方式：GET/POST
功能：ZT平台会实时把发送的消息报告推送到用户配置的下行地址中。用
户获取网关发送的数据,
接收成功返回0，接收不到数据返回非0
推送后用户方没有返回值，ZT平台默认推送三次后，不再推送
方式1：批量推送方式（客服设置）间隔5秒/次
此方式需要用户在ZT平台填写下行地址
我平台每次返回400(最大)组内容，客户被动接收状态报告并解析之
推送URL格式：例如：https://www.wendangku.net/doc/2213658360.html,/getReport.do?param=xxx https://www.wendangku.net/doc/2213658360.html,/getReport.do?param=201511061527558529,138 ********,1,2015-11-06 15:28:56
param参数规则如下：消息ID,手机号码,状态,时间;消息ID,手机号码,状态,时间
7 / 13
说明：每一组中由消息ID，手机号码，状态，时间组成，并由英文,分开，每一组之间又由英文;分开
用户接收成功需要向SMS平台返回0
方式2：主动提取状态报告（客服设置）
我平台每次返回400(最大)组内容，客户被动接收状态报告并解析之，时间间隔最好定为1分钟左右，输入参数包括用户名和密码
提取URL地址：例如：https://www.wendangku.net/doc/2213658360.html,/batchreportNget.do?username=xxx&password=xxxx&
8 / 13
tkey=2016xxxxxxxxxx
说明：每一组中由消息ID，手机号码，状态，时间组成，并由英文,分开，每一组之间又由英文;分开
5、回复内容接口
回复接口提交方式：GET
功能：获取上行内容，ZT平台会自动实时的推送用户手机回复的内容到上行地址中。推送后用户方没有返回值，ZT平台默认推送三次后，不再推送。
注：回复是手机到网关，网关到我们的系统。从手机到网关只有手机号可用于识别网关到我们的系统，我们系统中的消息ID，是取的这号码的最新的消息ID，只能做参考用。用手机号码匹配消息ID参考使用。
方式1：推送方式
此方式需要在ZT短信平台中填写上行地址
9 / 13
例如：https://www.wendangku.net/doc/2213658360.html,/getreCover.do
推送URL格式：
mobile=xxxx&content=xxxxx&msgid=xxxxx&xh=xxxxx;
一次推送一个号码，mobile指手机号，content指回复的内容，msgid 指上行对应的msgid，xh代表扩展号码。
用户接收回复内容成功，需要向SMS平台返回0。
回复内容接口推送的内容样例：130********,内容,12121209876512,1023；
方式2：主动提取
时间间隔最好定为1分钟左右,此方式需要在ZT短信平台中填写上行地址，地址一定要标记填写为：initiative-grab-reply
10 / 13
输入参数包括用户名和密码
https://www.wendangku.net/doc/2213658360.html,/batchreplygetN.do?username=xxx&password=xxxx&tkey =2016xxxxxxxxxx
说明：返回格式为：手机号，内容，消息ID，小号，时间，他们之间以[r]分开，分组之间以[p]分开，最大返回50组内容。,只能取一次
11 / 13
6、发送量数据报表提取
查询地址：提交地址：https://www.wendangku.net/doc/2213658360.html,/submitStatisticsN.do?username=xxx&password=xxxx&t key=2016xxxxxxxxxx&dstime=20160420
功能说明：
主要是查询用户发送的短信条数数据，根据时间查询（报表系统已经生成，所以不会变化,数据非当天的），查询数据包含用户自己及下面的子用户或终端输入参数：
12 / 13
输出参数：
13 / 13