1、在 腾讯云开通短信服务,并申请签名
和正文模板
腾讯云短信 https://console.cloud.tencent.com/smsv2
a、签名即是短信的开头。例如 【腾讯云短信】xxxxxxx;
b、正文模板即短信内容, 变量部分使用{1}
, 数字从1开始累推。例如:
今天是{1}佳节,{2}祝您节日快乐!
1 和 2 即可以我们在代码里进行赋值;
2、安装短信 tencentcloud-sdk-nodejs
SDK 包
pnpm add tencentcloud-sdk-nodejs -S
或者使用npm npm install tencentcloud-sdk-nodejs -S
3、新建一个 sms.ts
文件,封装短信方法
需提前准备自己的腾讯云访问秘钥https://console.cloud.tencent.com/cam/capi
获取 secretId
和 secretKey
import * as tencentcloud from "tencentcloud-sdk-nodejs" // 引入 短信 sdk
const smsClient = tencentcloud.sms.v20210111.Client // 使用 sms 客户端
// 实例化短信客户端
const client = new smsClient({
credential: {
/* 必填:腾讯云账户密钥对secretId,secretKey。
* 这里采用的是从环境变量读取的方式,需要在环境变量中先设置这两个值。
* 你也可以直接在代码中写死密钥对,但是小心不要将代码复制、上传或者分享给他人,
* 以免泄露密钥对危及你的财产安全。
* SecretId、SecretKey 查询: https://console.cloud.tencent.com/cam/capi */
secretId: process.env.TENCENT_SECRET_ID,
secretKey: process.env.TENCENT_SECRET_KEY,
},
/* 必填:地域信息,可以直接填写字符串ap-guangzhou,支持的地域列表参考 https://cloud.tencent.com/document/api/382/52071#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8 */
region: "ap-guangzhou",
/* 非必填:
* 客户端配置对象,可以指定超时时间等配置 */
profile: {
/* SDK默认用TC3-HMAC-SHA256进行签名,非必要请不要修改这个字段 */
signMethod: "HmacSHA256",
httpProfile: {
/* SDK默认使用POST方法。
* 如果你一定要使用GET方法,可以在这里设置。GET方法无法处理一些较大的请求 */
reqMethod: "POST",
/* SDK有默认的超时时间,非必要请不要进行调整
* 如有需要请在代码中查阅以获取最新的默认值 */
reqTimeout: 30,
/**
* 指定接入地域域名,默认就近地域接入域名为 sms.tencentcloudapi.com ,也支持指定地域域名访问,例如广州地域的域名为 sms.ap-guangzhou.tencentcloudapi.com
*/
endpoint: "sms.tencentcloudapi.com"
},
},
})
只需配置 secretId 和 secretKey , 其他的使用默认值,不用修改。
如果 需要接入指定地域。参考 https://cloud.tencent.com/document/api/382/52071#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8
通过 client.SendSms
方法即可发送短信:
client.SendSms(params, (err, response) => {
if (err) {
// 发送失败,打印错误信息
console.log(err)
return
}
// 发送成功
console.log(response)
})
params 参数详解
const params = {
//短信应用ID: 在短信控制台,应用管理,应用列表里;开通短信服务时,会有一个默认应用,直接使用即可
SmsSdkAppId: "140083xx",
/* 短信签名内容: 使用 UTF-8 编码,必须填写已审核通过的签名 */
SignName: "腾讯云",
/* 模板 ID: 必须填写已审核通过的模板 ID */
TemplateId: "449739",
/* 模板参数对应的内容: 模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致,若无模板参数,则设置为空 */
TemplateParamSet: ["{1}的内容","{2}的内容"],
/* 下发手机号码,采用 e.164 标准,+[国家或地区码][手机号]
* 示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号,最多不要超过200个手机号*/
PhoneNumberSet: ["+8613711112222"],
/* 用户的 session 内容(无需要可忽略): 可以携带用户侧 ID 等上下文信息,server 会原样返回 */
SessionContext: "",
/* 短信码号扩展号(无需要可忽略): 默认未开通,如需开通请联系 [腾讯云短信小助手] */
ExtendCode: "",
/* 国内短信无需填写该项;国际/港澳台短信已申请独立 SenderId 需要填写该字段,默认使用公共 SenderId,无需填写该字段。*/
SenderId: "",
}
SmsSdkAppId
: 短信应用id, 在控制台,应用管理 > 应用列表里
SignName
: 为自己申请通过的 签名内容。 即短信开头
TemplateId
: 为自己申请通过的正文内容模板id。
TemplateParamSet
: 正文模板里参数对应的内容值。即模板变量对应的含义。数组形式。例如我们的模板里使用了 {1} {2} {3} 则TemplateParamSet填写 ["{1}的内容","{2}的内容","{3}的内容"]
PhoneNumberSet
:要发送短信的手机号。 格式 ["+86手机号","+86手机号"]
,不能超过200个 .
其他参数无特殊要求可不用填写。
每次发送短信,调用 client.SendSms
方法,传入自己的参数即可。