腾讯云短信平台对接方案

780 阅读7分钟

一、背景

目前开发项目中,相信大家都遇到过需要发送短信的情况。那么我们一般是使用第三方服务的嘛,所以这里我有对腾讯云做的API做过对接,所以一些心得写下来给大家参开。可能有人要问了,人家官网文档写得好好的,要你在这巴拉巴拉?我这里只是做为一个对接者的身份和观点去使用情况告诉大家我遇到的问题。官网写的他们自己是知道什么东西在什么地方怎么配置,我们作为对接人肯定要到处寻找文档的。那么开始吧!

二、对接前准备

那么你需要开通腾讯云账号。cloud.tencent.com/ 怎么注册你们自己看吧,这个就还好啦。 注册账号好了以后。我们直接去产品搜索短信,进入短信SMS平台,也可以打开我下面的链接。 console.cloud.tencent.com/smsv2/manag…

这里开通短信平台后,个人会送100条国内,企业送1000条。感觉可有可无。

这些准备好以后。下面开始

三、对接

我们要对接肯定是要打开文档啦,对不对,API文档在这里: cloud.tencent.com/document/pr…

他们提供了API和SDK文档对接,还是一样,个人觉得SDK靠谱,为啥呢,前面对接U盾说过,人家都已经写好了代码了,你直接用方法,把该避开的都给你避开了。 那么就

image.png

我们按照他说的去我们的POM.XML文件加入jar包

<dependency>
     <groupId>com.tencentcloudapi</groupId>
     <artifactId>tencentcloud-sdk-java</artifactId>
     <version>3.1.270</version><!-- 注:这里只是示例版本号(可直接使用),可获取并替换为 最新的版本号,注意不要使用4.0.x版本(非最新版本) -->
</dependency>

引入之后,当然我们去看看下面内容。

发生短信的代码示例

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.v20210111.SmsClient;
// 导入要请求接口对应的request response类
import com.tencentcloudapi.sms.v20210111.models.SendSmsRequest;
import com.tencentcloudapi.sms.v20210111.models.SendSmsResponse;
/**
* Tencent Cloud Sms Sendsms
*
*/
public class SendSms
{
  public static void main(String[] args)
  {
      try {
          /* 必要步骤:
           * 实例化一个认证对象,入参需要传入腾讯云账户密钥对secretId,secretKey。
           * 这里采用的是从环境变量读取的方式,需要在环境变量中先设置这两个值。
           * 你也可以直接在代码中写死密钥对,但是小心不要将代码复制、上传或者分享给他人,
           * 以免泄露密钥对危及你的财产安全。
           * CAM密匙查询: 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);
          /* 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/smsv2
           * sms helper: https://cloud.tencent.com/document/product/382/3773 */
           /* 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId,示例如1400006666 */
          String sdkAppId = "1400009099";
          req.setSmsSdkAppId(sdkAppId);
           /* 短信签名内容: 使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 [短信控制台] 查看 */
          String signName = "签名内容";
          req.setSignName(signName);
           /* 国际/港澳台短信 SenderId: 国内短信填空,默认未开通,如需开通请联系 [sms helper] */
          String senderid = "";
          req.setSenderId(senderid);
           /* 用户的 session 内容: 可以携带用户侧 ID 等上下文信息,server 会原样返回 */
          String sessionContext = "xxx";
          req.setSessionContext(sessionContext);
           /* 短信号码扩展号: 默认未开通,如需开通请联系 [sms helper] */
          String extendCode = "";
          req.setExtendCode(extendCode);
           /* 模板 ID: 必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台] 查看 */
          String templateId = "400000";
          req.setTemplateId(templateId);
           /* 下发手机号码,采用 E.164 标准,+[国家或地区码][手机号]
           * 示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号,最多不要超过200个手机号 */
          String[] phoneNumberSet = {"+8621212313123", "+8612345678902", "+8612345678903"};
          req.setPhoneNumberSet(phoneNumberSet);
           /* 模板参数: 若无模板参数,则设置为空 */
          String[] templateParamSet = {"5678"};
          req.setTemplateParamSet(templateParamSet);
           /* 通过 client 对象调用 SendSms 方法发起请求。注意请求方法名与请求对象是对应的
           * 返回的 res 是一个 SendSmsResponse 类的实例,与请求对象对应 */
          SendSmsResponse res = client.SendSms(req);
           // 输出json格式的字符串回包
          System.out.println(SendSmsResponse.toJsonString(res));
           // 也可以取出单个值,你可以通过官网接口文档或跳转到response对象的定义处查看返回字段的定义
          System.out.println(res.getRequestId());
       } catch (TencentCloudSDKException e) {
          e.printStackTrace();
      }
  }
}

其实我感觉这里官方文档注释确实很有耐心。已经非常完整。但是唯一我需要补充几点是这里

   /* 国际/港澳台短信 SenderId: 国内短信填空,默认未开通,如需开通请联系 [sms helper] */
          String senderid = "";

刚开始我一直以为发生国际短信会有这个senderid,结果是我理解错了,无论国际短信还是国内都不需要,这个玩意根本不开通,大客户才会给你搞个。 发生国际短信只要在

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

吧国家区号换了,然后你买了国际套餐就可以发了。

还有就是有一点哈,官网有点坑。

image.png

国内和国际短信的摸版是不一样的哦,如果分别创建是话ID是不一样的,对我们对接特麻烦。 但是有一点,可以先建好国内短信,然后它有复制建可以复制过去。这样ID是一样的。

四、总结

国内这些大厂确实在文档方面起到了特别好的带头作用。对我们开发者而言,不用什么客服进行技术对接,跟着文档,一步一步操作。就能够完成实现。其实我还对接过腾讯云的COS对象文件存储,这个也挺有意思,过两天整理出来。为什么阿里云叫oss。个人感觉吧,可能是腾讯看到人家阿里已经有这样的产品叫这个名字了,我还要搞个这样的产品,如果技术名字也一样岂不是太LOW,所以我就要是COS。