前期准备
-
根据运营商的要求,目前此接口只对实名认证的企业用户开放使用,所以在使用之前请确保您是实名认证的企业用户
-
申请接口,你可以在个人中心 ➡️ 数据中心 ➡️ 我的API 模块看到此接口的调用凭证请求key
-
购买数据的请求次数(免费和有赠送次数的接口可以先行调试)
-
您必须在聚合官网的个人中心里面提前申请短信模板,待客服审核通过后才能调用接口
特别说明
-
请仔细阅读官网的接口文档,这是聚合数据与开发者的约定,它将有助于您对接口业务的理解,从而顺利的开展开发工作
-
本示例的侧重点,是帮助开发者顺利获取到接口的响应数据,对于开发者的数据处理等业务逻辑,本文不会展开讨论
-
由于水平能力所限,示例中难免存在错误和疏漏,如有发现还请大家批评指正
接口备注
-
运营商限制同1个号码同1个签名的内容1分钟内只能接收1条,10分钟3条,1小时内4条,一天20条,否则可能会被运营商屏蔽
-
短信api接口本身不限制发送频率,具体发送频率需要用户自行设置,只限国内手机号
-
请务必添加图片验证码等防恶意攻击的机制,以防短信轰炸,营销内容最后加回T退订,营销短信发送时间为:8:30至21:30。营销内容有防钓鱼机制,请勿单条发送,移动20条起(循环调用),联通电信不限制
-
短信内容(包含签名)小于等于70个字符为计费1条。超过70个字符为长短信,按每67个字计费
参数说明
参数名 | 必填 | 说明 |
---|---|---|
mobile | true | 手机号 |
tpl_id | true | 模板id |
key | true | 申请的请求key |
tpl_value | false | 模板变量,根据模板中变量决定,可为空 |
maven依赖
<dependency>
<groupId>net.sf.json-lib</groupId>
<artifactId>json-lib</artifactId>
<version>2.2.3</version>
<classifier>jdk15</classifier>
</dependency>
运行代码之前
你需要修改两个部分
-
成员变量
// TODO: 您需要改为自己的请求key public static final String KEY = "您需要改为自己的请求key"; // TODO: 您需要改为自己的模板id public static final int TPL_ID = 3010;
-
局部变量
// TODO: 改为自己手机号测试看看 String mobile = "177*****077"; // TODO: 改为您模板中的需要的变量 String variable = "#code#=12345&#total#=100";
全部代码
package cn.juhe.demo;
import net.sf.json.JSONObject;
import java.io.*;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLEncoder;
/**
* @Author: micro cloud fly
* @Description: 短信API的调用示例
* @Date: Created in 1:45 下午 2020/10/9
*/
public class Demo54 {
//接口请求地址
public static final String URL = "http://v.juhe.cn/sms/send?mobile=%s&tpl_id=%s&tpl_value=%s&key=%s";
//申请接口的请求key
// TODO: 您需要改为自己的请求key
public static final String KEY = "您需要改为自己的请求key";
//此次发送短信需要使用的短信模板
//3010模板对应的发送内容为:【聚合数据1】您的验证码是#code#.你还剩余次数#total#,如非本人操作,请忽略本短信
//其中#code#是短信模板中的变量,用于开发者动态生成验证码
//在运行代码的时候您需要改为自己拥有的模板
// TODO: 您需要改为自己的模板id
public static final int TPL_ID = 3010;
public static void main(String[] args) {
//用于接收短信的手机号码,你需要修改此处
// TODO: 改为自己手机号测试看看
String mobile = "17715******77";
//短信模板中的您自定义的变量
// TODO: 改为您模板中的需要的变量
String variable = "#code#=12345&#total#=100";
print(mobile, variable);
}
/**
* 打印请求结果
*
* @param mobile 手机号
* @param variable 模板变量
*/
public static void print(String mobile, String variable) {
//发送http请求的url
String url = null;
try {
url = String.format(URL, mobile, TPL_ID, URLEncoder.encode(variable, "utf-8"), KEY);
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
String response = doGet(url);
System.out.println(response);
try {
JSONObject jsonObject = JSONObject.fromObject(response);
int error_code = jsonObject.getInt("error_code");
if (error_code == 0) {
System.out.println("调用接口成功");
JSONObject result = jsonObject.getJSONObject("result");
String sid = result.getString("sid");
int fee = result.getInt("fee");
System.out.println("本次发送的唯一标示:" + sid);
System.out.println("本次发送消耗的次数:" + fee);
}else{
System.out.println("调用接口失败:"+ jsonObject.getString("reason"));
}
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* get方式的http请求
*
* @param httpUrl 请求地址
* @return 返回结果
*/
public static String doGet(String httpUrl) {
HttpURLConnection connection = null;
InputStream inputStream = null;
BufferedReader bufferedReader = null;
String result = null;// 返回结果字符串
try {
// 创建远程url连接对象
URL url = new URL(httpUrl);
// 通过远程url连接对象打开一个连接,强转成httpURLConnection类
connection = (HttpURLConnection) url.openConnection();
// 设置连接方式:get
connection.setRequestMethod("GET");
// 设置连接主机服务器的超时时间:15000毫秒
connection.setConnectTimeout(15000);
// 设置读取远程返回的数据时间:60000毫秒
connection.setReadTimeout(60000);
// 发送请求
connection.connect();
// 通过connection连接,获取输入流
if (connection.getResponseCode() == 200) {
inputStream = connection.getInputStream();
// 封装输入流,并指定字符集
bufferedReader = new BufferedReader(new InputStreamReader(inputStream, "UTF-8"));
// 存放数据
StringBuilder sbf = new StringBuilder();
String temp;
while ((temp = bufferedReader.readLine()) != null) {
sbf.append(temp);
sbf.append(System.getProperty("line.separator"));
}
result = sbf.toString();
}
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
// 关闭资源
if (null != bufferedReader) {
try {
bufferedReader.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (null != inputStream) {
try {
inputStream.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (connection != null) {
connection.disconnect();// 关闭远程连接
}
}
return result;
}
/**
* post方式的http请求
*
* @param httpUrl 请求地址
* @param param 请求参数
* @return 返回结果
*/
public static String doPost(String httpUrl, String param) {
HttpURLConnection connection = null;
InputStream inputStream = null;
OutputStream outputStream = null;
BufferedReader bufferedReader = null;
String result = null;
try {
URL url = new URL(httpUrl);
// 通过远程url连接对象打开连接
connection = (HttpURLConnection) url.openConnection();
// 设置连接请求方式
connection.setRequestMethod("POST");
// 设置连接主机服务器超时时间:15000毫秒
connection.setConnectTimeout(15000);
// 设置读取主机服务器返回数据超时时间:60000毫秒
connection.setReadTimeout(60000);
// 默认值为:false,当向远程服务器传送数据/写数据时,需要设置为true
connection.setDoOutput(true);
// 设置传入参数的格式:请求参数应该是 name1=value1&name2=value2 的形式。
connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
// 通过连接对象获取一个输出流
outputStream = connection.getOutputStream();
// 通过输出流对象将参数写出去/传输出去,它是通过字节数组写出的
outputStream.write(param.getBytes());
// 通过连接对象获取一个输入流,向远程读取
if (connection.getResponseCode() == 200) {
inputStream = connection.getInputStream();
// 对输入流对象进行包装:charset根据工作项目组的要求来设置
bufferedReader = new BufferedReader(new InputStreamReader(inputStream, "UTF-8"));
StringBuilder sbf = new StringBuilder();
String temp;
// 循环遍历一行一行读取数据
while ((temp = bufferedReader.readLine()) != null) {
sbf.append(temp);
sbf.append(System.getProperty("line.separator"));
}
result = sbf.toString();
}
} catch (MalformedURLException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} finally {
// 关闭资源
if (null != bufferedReader) {
try {
bufferedReader.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (null != outputStream) {
try {
outputStream.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (null != inputStream) {
try {
inputStream.close();
} catch (IOException e) {
e.printStackTrace();
}
}
if (connection != null) {
connection.disconnect();
}
}
return result;
}
}