【java】腾讯云SMS工具类

最新推荐文章于 2024-06-12 11:59:04 发布
最新推荐文章于 2024-06-12 11:59:04 发布
阅读量107 收藏
点赞数 1
分类专栏： JAVA 文章标签： java 腾讯云 开发语言
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_49000161/article/details/133637135
版权

2023/9/28

官方网站快速入门

https://cloud.tencent.com/document/product/382/37745

快速入门

签名和模板

一般发送短信为
:::info
【腾讯云】您的验证码是：XXXX
:::
因此短信中有三个相关概念

  1. 短信签名

以上为例，【腾讯云】 为短信签名。短信签名需要进入腾讯云 国内短信->签名管理创建
image.png

  1. 正文模板

创建正文模板，{ 1 } 为短信中的参数
image.png

  1. 应用管理 （后面用到 SDKAppID）

image.png

springboot整合

java sdk网址 查看相关整合文档

https://cloud.tencent.com/document/product/382/43194

前提条件（官网写的）

  • 已开通短信服务，创建签名和模板并通过审核，具体操作请参见 国内短信快速入门。
  • 如需发送国内短信，需要先 购买国内短信套餐包。
  • 已准备依赖环境：JDK 7 及以上版本。
  • 已在访问管理控制台 >API密钥管理页面获取 SecretID 和 SecretKey。
    • SecretID 用于标识 API 调用者的身份。
    • SecretKey 用于加密签名字符串和服务器端验证签名字符串的密钥，SecretKey 需妥善保管，避免泄露。
  • 短信的调用地址为sms.tencentcloudapi.com。
密钥管理创建 SecretID 和 SecretKey

API密钥代表调用的账号身份，和拥有的权限。

导入maven坐标
  1. github仓库 https://github.com/TencentCloud/tencentcloud-sdk-java
<dependency>
    <groupId>com.tencentcloudapi</groupId>
    <artifactId>tencentcloud-sdk-java</artifactId>
    <version>3.1.423</version>
</dependency>
API Explorer 模拟短信发送控制台

通过填写相关信息，模拟发送一次短信，成功后 右边代码复制到 springboot的一个工具类中
image.png

发送短信

这段代码是官网的，因此 再此基础上进行封装使用。
可以看出分为三步：

  1. 创建认证对象。
  2. 创建请求。
  3. 认证对象发送请求获取结果。
public class SendSms
{
    public static void main(String[] args)
    {
        try {
            /* 必要步骤：
             * 实例化一个认证对象，入参需要传入腾讯云账户密钥对secretId，secretKey。
             * 这里采用的是从环境变量读取的方式，需要在环境变量中先设置这两个值。
             * 您也可以直接在代码中写死密钥对，但是小心不要将代码复制、上传或者分享给他人，
             * 以免泄露密钥对危及您的财产安全。
             * SecretId、SecretKey 查询: https://console.cloud.tencent.com/cam/capi */
            Credential cred = new Credential("secretId", "secretKey");

            // 实例化一个http选项，可选，没有特殊需求可以跳过
            HttpProfile httpProfile = new HttpProfile();
            // 设置代理（无需要直接忽略）
            // httpProfile.setProxyHost("真实代理ip");
            // httpProfile.setProxyPort(真实代理端口);
            /* SDK默认使用POST方法。
             * 如果您一定要使用GET方法，可以在这里设置。GET方法无法处理一些较大的请求 */
            httpProfile.setReqMethod("POST");
            /* SDK有默认的超时时间，非必要请不要进行调整
             * 如有需要请在代码中查阅以获取最新的默认值 */
            httpProfile.setConnTimeout(60);
            /* 指定接入地域域名，默认就近地域接入域名为 sms.tencentcloudapi.com ，也支持指定地域域名访问，例如广州地域的域名为 sms.ap-guangzhou.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，支持的地域列表参考 https://cloud.tencent.com/document/api/382/52071#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8 */
            SmsClient client = new SmsClient(cred, "ap-guangzhou",clientProfile);
            /* 实例化一个请求对象，根据调用的接口和实际情况，可以进一步设置请求参数
             * 您可以直接查询SDK源码确定接口有哪些属性可以设置
             * 属性可能是基本类型，也可能引用了另一个数据结构
             * 推荐使用IDE进行开发，可以方便的跳转查阅各个接口和数据结构的文档说明 */
            SendSmsRequest req = new SendSmsRequest();

            /* 填充请求参数,这里request对象的成员变量即对应接口的入参
             * 您可以通过官网接口文档或跳转到request对象的定义处查看请求参数的定义
             * 基本类型的设置:
             * 帮助链接：
             * 短信控制台: https://console.cloud.tencent.com/smsv2
             * 腾讯云短信小助手: https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81 */

            /* 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId，示例如1400006666 */
            // 应用 ID 可前往 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 查看
            String sdkAppId = "1400009099";
            req.setSmsSdkAppId(sdkAppId);

            /* 短信签名内容: 使用 UTF-8 编码，必须填写已审核通过的签名 */
            // 签名信息可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-sign) 或 [国际/港澳台短信](https://console.cloud.tencent.com/smsv2/isms-sign) 的签名管理查看
            String signName = "腾讯云";
            req.setSignName(signName);

            /* 模板 ID: 必须填写已审核通过的模板 ID */
            // 模板 ID 可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-template) 或 [国际/港澳台短信](https://console.cloud.tencent.com/smsv2/isms-template) 的正文模板管理查看
            String templateId = "449739";
            req.setTemplateId(templateId);

            /* 模板参数: 模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致，若无模板参数，则设置为空 */
            String[] templateParamSet = {"1234"};
            req.setTemplateParamSet(templateParamSet);

            /* 下发手机号码，采用 E.164 标准，+[国家或地区码][手机号]
             * 示例如：+8613711112222， 其中前面有一个+号 ，86为国家码，13711112222为手机号，最多不要超过200个手机号 */
            String[] phoneNumberSet = {"+8621212313123", "+8612345678902", "+8612345678903"};
            req.setPhoneNumberSet(phoneNumberSet);

            /* 用户的 session 内容（无需要可忽略）: 可以携带用户侧 ID 等上下文信息，server 会原样返回 */
            String sessionContext = "";
            req.setSessionContext(sessionContext);

            /* 短信码号扩展号（无需要可忽略）: 默认未开通，如需开通请联系 [腾讯云短信小助手] */
            String extendCode = "";
            req.setExtendCode(extendCode);

            /* 国内短信无需填写该项；国际/港澳台短信已申请独立 SenderId 需要填写该字段，默认使用公共 SenderId，无需填写该字段。注：月度使用量达到指定量级可申请独立 SenderId 使用，详情请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。*/
            String senderid = "";
            req.setSenderId(senderid);

            /* 通过 client 对象调用 SendSms 方法发起请求。注意请求方法名与请求对象是对应的
             * 返回的 res 是一个 SendSmsResponse 类的实例，与请求对象对应 */
            SendSmsResponse res = client.SendSms(req);

            // 输出json格式的字符串回包
            System.out.println(SendSmsResponse.toJsonString(res));

            // 也可以取出单个值，您可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义
            // System.out.println(res.getRequestId());

            /* 当出现以下错误码时，快速解决方案参考
             * [FailedOperation.SignatureIncorrectOrUnapproved](https://cloud.tencent.com/document/product/382/9558#.E7.9F.AD.E4.BF.A1.E5.8F.91.E9.80.81.E6.8F.90.E7.A4.BA.EF.BC.9Afailedoperation.signatureincorrectorunapproved-.E5.A6.82.E4.BD.95.E5.A4.84.E7.90.86.EF.BC.9F)
             * [FailedOperation.TemplateIncorrectOrUnapproved](https://cloud.tencent.com/document/product/382/9558#.E7.9F.AD.E4.BF.A1.E5.8F.91.E9.80.81.E6.8F.90.E7.A4.BA.EF.BC.9Afailedoperation.templateincorrectorunapproved-.E5.A6.82.E4.BD.95.E5.A4.84.E7.90.86.EF.BC.9F)
             * [UnauthorizedOperation.SmsSdkAppIdVerifyFail](https://cloud.tencent.com/document/product/382/9558#.E7.9F.AD.E4.BF.A1.E5.8F.91.E9.80.81.E6.8F.90.E7.A4.BA.EF.BC.9Aunauthorizedoperation.smssdkappidverifyfail-.E5.A6.82.E4.BD.95.E5.A4.84.E7.90.86.EF.BC.9F)
             * [UnsupportedOperation.ContainDomesticAndInternationalPhoneNumber](https://cloud.tencent.com/document/product/382/9558#.E7.9F.AD.E4.BF.A1.E5.8F.91.E9.80.81.E6.8F.90.E7.A4.BA.EF.BC.9Aunsupportedoperation.containdomesticandinternationalphonenumber-.E5.A6.82.E4.BD.95.E5.A4.84.E7.90.86.EF.BC.9F)
             * 更多错误，可咨询[腾讯云助手](https://tccc.qcloud.com/web/im/index.html#/chat?webAppId=8fa15978f85cb41f7e2ea36920cb3ae1&title=Sms)
             */


        } catch (TencentCloudSDKException e) {
            e.printStackTrace();
        }
    }
}

进行工具类封装

  1. 创建认证对象
    public static SmsClient getSmsClient(){

        Credential cred = new Credential(SecretId,SecretKey);
        HttpProfile httpProfile = new HttpProfile();
        httpProfile.setEndpoint("sms.tencentcloudapi.com");
//        httpProfile.setEndpoint("sms.ap-shanghai-fsi.tencentcloudapi.com");
        // 实例化一个client选项，可选的，没有特殊需求可以跳过
        ClientProfile clientProfile = new ClientProfile();
        clientProfile.setHttpProfile(httpProfile);
        // 实例化要请求产品的client对象,clientProfile是可选的  第二个参数是地域信息
        SmsClient client = new SmsClient(cred, "ap-nanjing", clientProfile);
        return client;
    }
  1. 创建发送请求对象
private static SendSmsRequest getSendSmsRequest(String phoneNumber, String templateCode, Map<String,
            String> vars) {

        SendSmsRequest req = new SendSmsRequest();
        //设置固定的参数
        req.setSmsSdkAppId(smsSdkAppId);// 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId
        req.setSignName(signNam);//短信签名内容: 使用 UTF-8 编码，必须填写已审核通过的签名
        req.setTemplateId(templateCode);//模板 ID: 必须填写已审核通过的模板 ID

        //设置发送相关的参数
        String[] phoneNumberSet1 = {"+86"+phoneNumber};
        req.setPhoneNumberSet(phoneNumberSet1);//发送的手机号

        // 创建一个List来存储所有的值
        List<String> valuesList = new ArrayList<>();

        // 遍历HashMap，并将所有的值添加到List中
        for (String value : vars.values()) {
            valuesList.add(value);
        }
        //设置模板参数

        String[] templateParamSet1 = valuesList.toArray(new String[0]);
        req.setTemplateParamSet(templateParamSet1);

        return req;
    }
  1. 认证对象发送请求

这里要根据response进行判断下 是否成功。

    private static boolean getSmsResult(SendSmsRequest request) {
        SmsClient smsClient = Tencent_SMSUtil.getSmsClient();
        SendSmsResponse response = null;
        try {
            response = smsClient.SendSms(request);
            return true;
        } catch (TencentCloudSDKException e) {
            //e.printStackTrace();
            System.out.println(e.toString());
        }
        return  false;
    }

因此 发送验证码方法 （一个参数）

/**
     * 5分钟验证码
     * @param phone 接受验证码
     * @param verificationCode 验证码
     * @return
     */
    public static boolean SMS4Code(String phone,String verificationCode){

        Map<String, String> vars = new HashMap<String, String>();
        vars.put("code", verificationCode);
        // 实例化一个请求对象,每个接口都会对应一个request对象
        SendSmsRequest request = Tencent_SMSUtil.getSendSmsRequest(phone, verificationCodeTemplateId, vars);

        return Tencent_SMSUtil.getSmsResult(request);
    }

三个参数短信

/**
     * 礼品发货通知
     * @param phone 手机号
     * @param hashMap 参数值 {1}-{2}-{3}
     * @return
     */
    public static  boolean SMSGiftNotic(String phone,Map hashMap){

        // 实例化一个请求对象,每个接口都会对应一个request对象
        SendSmsRequest request = Tencent_SMSUtil.getSendSmsRequest(phone, giftNoticTemplateId, hashMap);

        return Tencent_SMSUtil.getSmsResult(request);
    }

其他官网类似

三月不知肉味y
关注
  • 1
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
用java完美解决腾讯云COS签名生成问题
tangjinquan1157的博客
01-06 2395
亲自验证有效并能成功 首先需要用到签名的工具类 签名工具类方法基本没有使用，用到了一些定义好的变量 ，有助于自己记住 import org.apache.commons.codec.digest.DigestUtils; import org.apache.commons.codec.digest.HmacUtils; import java.io.UnsupportedEncodingExce...
java腾讯云sms短信工具类
qq_35097597的博客
11-07 113
根据腾讯云官方文档制作sms工具类。
腾讯云签名方法
Hqq_55732700的博客
01-19 2311
腾讯云 API 会对每个请求进行身份验证，用户需要使用安全凭证，经过特定的步骤对请求进行签名（Signature），每个请求都需要在公共参数中指定该签名结果并以指定的方式和格式发送请求。 https://cloud.tencent.com/document/product/1278/55260 为什么要进行签名 签名通过以下方式帮助保护请求： 验证请求者的身份 签名确保请求是由持有有效访问密钥的人发送的。请参阅控制台 云 API 密钥 页面获取密钥相关信息。 保护传输中的数据 为了防止请求在传输过程中被篡改
腾讯开放平台接口鉴权（计算签名）工具类 java版
SeasmallTop的博客
02-04 2561
腾讯开放平台 接口鉴权（签名）工具类 java版 package top.seasmall.platform.core.config.nettyws.util; import cn.hutool.core.util.StrUtil; import cn.hutool.core.util.URLUtil; import cn.hutool.crypto.digest.MD5; import ja...
腾讯云通信账号登录集成-Java签名工具类
weixin_33937913的博客
12-23 326
2019独角兽企业重金招聘Python工程师标准>>> ...
JAVA整合腾讯云实现短信发送功能
Jul_C18672868641的博客
03-15 478
腾讯云的官网： https://cloud.tencent.com/ 选择云产品-短信 申请签名 选择国内短信-签名管理，点击创建签名申请项目所需的签名，签名内容的值就是下面代码中的sign的值 创建模版 选择正文模版管理，点击创建正文模版，填写自己业务所需的短信内容，参数写为{1},{2}等，创建成功后的id即为代码中需要填写的templateId参数值 SDKAppID，AppKey 选择应用管理-应用列表，点击创建应用，创建属于当前项目的应用模块，创建成功后点击该模块，拿到工具类中的SDKAppI
java腾讯云sms短信开发_java实现发短信功能---腾讯云短信
weixin_33402252的博客
02-27 426
pom.xml引入依赖1.81.0.6com.github.qcloudsmsqcloudsms${tencent.qcloudsms.version}发送短信工具类package com.wayne.common.utils;import com.github.qcloudsms.*;import com.github.qcloudsms.httpclient.HTTPException;imp...
Java + 腾讯云发送短信（验证码）
zhiqiuqiu2的博客
06-18 1555
到这里Java + 腾讯云发送短信就已经完成了，后期会结合web项目一起使用，实现注册手机短信验证注册功能。如果申请通过的话，会有显示已生效的这里的 ID 和 签名内容我们后面都要用到。根据自己的需求去创建，可以是小程序、网站、微信公众号，按要求填写下面的信息等申请通过即可。在官网找到这个页面申请既可以了，不用钱的哈，免费的，使用期限是3个月100次。代码中空的设置值，已经在上标题中带大家找过了，复制进去就可以使用了。审批通过会显示已通过，模板中的 ID 和 内容是我们需要操作的。
腾讯云SMS短信服务实现
大白猫的博客
10-09 686
2.之后在写一个配置文件获取该yml的信息放到该类中加载带bean容器。
java阿里云SMS短信工具类
07-28
阿里云SMS短信工具类 Client client = createClient(); SendSmsRequest sendSmsRequest = new SendSmsRequest() .setPhoneNumbers(smsInfo.getPhoneNumber()) .setSignName(smsInfo.getSignName()) ....
sms工具类调用阿里云短信服务
03-03
sms工具类调用阿里云短信服务
Java实现SMS短信工具类（阿里云）
07-18
使用阿里云实现SMS短信发送
腾讯云sms短信服务sdk含核心jar包：qcloudsms-1.0.5.jar
03-24
腾讯云sms短信服务sdk含核心jar包：qcloudsms-1.0.5.jar 使用gradle的非常便捷，只需导入一个核心包 可在我博客内搜教程：腾讯云sms短信服务
Sms的短信工具类
12-26
第三方短信的接口工具类，短信发送
简单的项目部署脚本（转载）
u010230019的博客
06-09 635
有些项目团队喜欢使用docker启动java服务,那么我们同样可以将上述脚本稍做改造,来实现基于shell+docker的简单项目部署能力。可以将核心节点的错误或者失败内容通过webhook发送到对应的告警平台,比如钉钉、飞书机器人等。把~/.ssh/id_rsa.pub内容添加到远程仓库的ssh秘钥中。执行start.sh脚本打包部署。start.sh脚本内容。
Java——简单图书管理系统
m0_74100417的博客
06-09 1378
数据类型变量iffor数组方法类和对象封装继承多态抽象类和接口今天就是把上述知识点全部都用起来 图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理系统图书管理
修改菜品——后端Java
weixin_53717695的博客
06-09 442
修改菜品——后端Java
（Javascript）AI数字人mp4转canvas播放并去除背景绿幕
最新发布
lx_nhs的博客
06-12 438
去除前：去除后： 3、可能会出现的报错 （1）视频路径跨域问题：解决：vue开启代理
java中使用腾讯云发送短信服务
05-19
在Java中使用腾讯云发送短信服务，需要进行以下步骤： 1. 注册腾讯云账号，并开通短信服务。 2. 在腾讯云控制台中，创建应用和签名模板。应用表示您的业务场景，签名模板表示发送短信的签名和模板内容。 3. 在...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值