腾讯云短信服务发送验证码
- 1、前言
- 2、进入短信服务控制台
- 3、创建签名
- 4、创建模板
- 5、短信-应用管理-应用列表
- 6、创建密钥
- 7、SpringBoot实现短信验证码发送
- 7.1 引入依赖
- 7.2 常量参数类
- 7.3 短信发送的工具类
- 7.4 写个controller测试
- 7.5 PostMan测试一下
1、前言
由于阿里云需要备案过的域名或者已上线的APP才能申请短信签名,我的域名正在备案,申请还没通过,这里用腾讯云实现短信验证码的发送功能。腾讯云只需要你有个公众号就能申请短信签名,而且免费赠送200条。
2、进入短信服务控制台
3、创建签名
签名的审核很严格,必须按照规范的格式写,申请成功之后如下:
4、创建模板
模本你根据自己情况,看需要几个参数就选择对应的模板。
5、短信-应用管理-应用列表
默认都有 没有就创建个
6、创建密钥
选择继续使用
SecretId 用于标识 API 调用者的身份,SecretKey 用于加密签名字符串和服务器端验证签名字符串的密钥。
7、SpringBoot实现短信验证码发送
你也可以去腾讯云官网查看文档,文档挺全的。
7.1 引入依赖
<!-- https://mvnrepository.com/artifact/com.tencentcloudapi/tencentcloud-sdk-java -->
<dependency>
<groupId>com.tencentcloudapi</groupId>
<artifactId>tencentcloud-sdk-java</artifactId>
<version>3.1.395</version>
</dependency>
7.2 常量参数类
把上面要用到的SecretID, SecretKey, SdkAppID, signName, templateId参数封装
/** * 常量类 */ public class Constants {
//腾讯云账户密钥对: SecretID
public static final String SecretID = "SecretID";
//腾讯云账户密钥对: SecretKey
public static final String SecretKey = "SecretKey";
//SdkAppid
public static final String SdkAppid = "SdkAppid";
//signName :签名
public static final String signName = "xiong先生";
//短信模板id:
public static final String templateId ="978194";
public static String voicode="";
}
上面的常量你根据你自己的修改
7.3 短信发送的工具类
这里我只是测试短信验证码的发送功能,所以验证码直接给了个1234,没有使用随机数
package com.sms.tencentsms.utils;
import com.tencentcloudapi.common.Credential;
import com.tencentcloudapi.common.exception.TencentCloudSDKException;
//导入可选配置类
import com.tencentcloudapi.common.profile.ClientProfile;
import com.tencentcloudapi.common.profile.HttpProfile;
// 导入对应SMS模块的client
import com.tencentcloudapi.sms.v20190711.SmsClient;
// 导入要请求接口对应的request response类
import com.tencentcloudapi.sms.v20190711.models.SendSmsRequest;
import com.tencentcloudapi.sms.v20190711.models.SendSmsResponse;
import com.tencentcloudapi.sms.v20190711.models.SendStatus;import javax.servlet.http.HttpSession;
public class SendSms {
public static SendStatus[] sendSms(String[] phoneNumber ) { SendStatus[] returString= {}; try { /* 必要步骤: * 实例化一个认证对象,入参需要传入腾讯云账户密钥对secretId,secretKey。 * 这里采用的是从环境变量读取的方式,需要在环境变量中先设置这两个值。 * 你也可以直接在代码中写死密钥对,但是小心不要将代码复制、上传或者分享给他人, * 以免泄露密钥对危及你的财产安全。 * CAM密匙查询: https://console.cloud.tencent.com/cam/capi*/ Credential cred = new Credential(Constants.SecretID, Constants.SecretKey); // 实例化一个http选项,可选,没有特殊需求可以跳过 HttpProfile httpProfile = new HttpProfile(); // 设置代理
// httpProfile.setProxyHost("host");
// httpProfile.setProxyPort(port);
/* SDK默认使用POST方法。
* 如果你一定要使用GET方法,可以在这里设置。GET方法无法处理一些较大的请求 /
httpProfile.setReqMethod("POST");
/ SDK有默认的超时时间,非必要请不要进行调整
* 如有需要请在代码中查阅以获取最新的默认值 /
httpProfile.setConnTimeout(60);
/ SDK会自动指定域名。通常是不需要特地指定域名的,但是如果你访问的是金融区的服务
* 则必须手动指定域名,例如sms的上海金融区域名: sms.ap-shanghai-fsi.tencentcloudapi.com */
httpProfile.setEndpoint("sms.tencentcloudapi.com");/* 非必要步骤: * 实例化一个客户端配置对象,可以指定超时时间等配置 */ ClientProfile clientProfile = new ClientProfile(); /* SDK默认用TC3-HMAC-SHA256进行签名 * 非必要请不要修改这个字段 */ clientProfile.setSignMethod("HmacSHA256"); clientProfile.setHttpProfile(httpProfile); /* 实例化要请求产品(以sms为例)的client对象 * 第二个参数是地域信息,可以直接填写字符串ap-guangzhou,或者引用预设的常量 */ SmsClient client = new SmsClient(cred, "ap-guangzhou", clientProfile); /* 实例化一个请求对象,根据调用的接口和实际情况,可以进一步设置请求参数 * 你可以直接查询SDK源码确定接口有哪些属性可以设置 * 属性可能是基本类型,也可能引用了另一个数据结构 * 推荐使用IDE进行开发,可以方便的跳转查阅各个接口和数据结构的文档说明 */ SendSmsRequest req = new SendSmsRequest(); /* 填充请求参数,这里request对象的成员变量即对应接口的入参 * 你可以通过官网接口文档或跳转到request对象的定义处查看请求参数的定义 * 基本类型的设置: * 帮助链接: * 短信控制台: https://console.cloud.tencent.com/sms/smslist * sms helper: https://cloud.tencent.com/document/product/382/3773 */ /* 短信应用ID: 短信SdkAppid在 [短信控制台] 添加应用后生成的实际SdkAppid,示例如1400006666 */ String sdkappid = Constants.SdkAppid; req.setSmsSdkAppid(sdkappid); /* 短信签名内容: 使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 [短信控制台] 查看 */ String sign = Constants.signName; req.setSign(sign); /* 国际/港澳台短信 senderid: 国内短信填空,默认未开通,如需开通请联系 [sms helper] */
// String senderid = "";
// req.setSenderId(senderid);/* 用户的 session 内容: 可以携带用户侧 ID 等上下文信息,server 会原样返回 */
// String session = "xxx";
// req.setSessionContext(session);/* 短信码号扩展号: 默认未开通,如需开通请联系 [sms helper] */
// String extendcode = "xxx";
// req.setExtendCode(extendcode);/* 模板 ID: 必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台] 查看 */ String templateID = Constants.templateId; req.setTemplateID(templateID); /* 下发手机号码,采用 e.164 标准,+[国家或地区码][手机号] * 示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号,最多不要超过200个手机号*/ String[] phoneNumbers = {"+86"+phoneNumber}; req.setPhoneNumberSet(phoneNumber);
// 随机验证码
// int vode=ValidateCode.generateValidateCode(6);
String code="1234";/* 模板参数: 若无模板参数,则设置为空*/ String[] templateParams = {code}; req.setTemplateParamSet(templateParams); /* 通过 client 对象调用 SendSms 方法发起请求。注意请求方法名与请求对象是对应的 * 返回的 res 是一个 SendSmsResponse 类的实例,与请求对象对应 */ SendSmsResponse res = client.SendSms(req); // 输出json格式的字符串回包 System.out.println(SendSmsResponse.toJsonString(res)); // 也可以取出单个值,你可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义 System.out.println(res.getRequestId()); returString=res.getSendStatusSet(); } catch (TencentCloudSDKException e) { e.printStackTrace(); } return returString; }
}
7.4 写个controller测试
@RestController
@RequestMapping("/sms")
public class SendSmsController {@PostMapping("sendCodeAgain") public SendStatus[] sendCodeAgain(@RequestParam(value = "phone",required = true) String phone){ String[] phones={"+86"+phone}; SendStatus[] ret= SendSms.sendSms(phones); return ret; }
}