当今社会,手机短信验证码已成为确认身份、进行安全验证的重要方式之一。而在Node.js应用程序中,使用腾讯云提供的短信服务,能够轻松实现发送手机短信验证码的功能。本文将分享如何开通腾讯云短信服务以及如何在Node.js中使用腾讯云的短信服务SDK来发送手机短信验证码。
1.在腾讯云开通短信服务
个人用户认证成功后有免费的100条短信额度。后续购买大约0.03-0.05元/条。
开通服务后,首先进行签名和正文模版的申请。
签名即短信最前面“【】”里的部分,正文模版则为短信正文部分。
正文模版中的变量参数{1},{2}表示这两个地方的数值是可以通过代码进行赋值传递的。
2.安装腾讯云SDK
tencentcloud-sdk-nodejs
:腾讯云官方提供的短信服务SDK。
相关文档:腾讯云短信SDK
3.导入模块并实例化对象
复制代码
- import tencentcloud from 'tencentcloud-sdk-nodejs';
- // 导入对应产品模块的client models。
- const smsClient = tencentcloud.sms.v20210111.Client
- /* 必填:腾讯云账户密钥对secretId,secretKey。
- * 这里采用的是从环境变量读取的方式,需要在环境变量中先设置这两个值。
- * 你也可以直接在代码中写死密钥对,但是小心不要将代码复制、上传或者分享给他人,
- * 以免泄露密钥对危及你的财产安全。
- * SecretId、SecretKey 查询: https://console.cloud.tencent.com/cam/capi */
- const credential = {
- secretId: '填写自己的secretId',
- secretKey: '填写自己的secretKey'
- }
- /* 实例化要请求产品(以sms为例)的client对象 */
- const client = new smsClient({
- credential,
- /* 必填:地域信息,可以直接填写字符串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"
- },
- },
- })
4.函数封装
封装两个函数,用于发送短信和统计发送的短信的相关数据。
复制代码
- // 发送短信
- function sendMessage(params) {
- return new Promise((resolve, reject) => {
- // 通过client对象调用想要访问的接口,需要传入请求对象以及响应回调函数
- client.SendSms(params, function(err, response) {
- // 请求异常返回,打印异常信息
- if (err) {
- reject(error);
- } else {
- // 请求正常返回
- resolve(response);
- }
- })
- })
- }
- // 统计发送的短信数据
- function checkMessage(params) {
- return new Promise((resolve, reject) => {
- // 通过client对象调用想要访问的接口,需要传入请求对象以及响应回调函数
- client.SendStatusStatistics(params, function(err, response) {
- // 请求异常返回,打印异常信息
- if (err) {
- reject(err);
- } else {
- // 请求正常返回,打印response对象
- resolve(response)
- }
- })
- })
- }
5.传入参数并调用函数
(1)发送短信
复制代码
- // 传入所申请的正文模版参数列表 和 发送对象的手机号码
- async function send(TemplateParamSet,phone) {
- /* 请求参数 传入自己的应用id 签名信息 模版id 模版中变量参数的值和发送的目标手机号*/
- const params = {
- /* 短信应用ID: 短信SmsSdkAppId在 [短信控制台] 添加应用后生成的实际SmsSdkAppId,示例如1400006666 */
- // 应用 ID 可前往 [短信控制台](https://console.cloud.tencent.com/smsv2/app-manage) 查看
- SmsSdkAppId: "1400839034",
- /* 短信签名内容: 使用 UTF-8 编码,必须填写已审核通过的签名 */
- // 签名信息可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-sign) 或 [国际/港澳台短信](https://console.cloud.tencent.com/smsv2/isms-sign) 的签名管理查看
- SignName: "柠檬猫语个人网",
- /* 模板 ID: 必须填写已审核通过的模板 ID */
- // 模板 ID 可前往 [国内短信](https://console.cloud.tencent.com/smsv2/csms-template) 或 [国际/港澳台短信](https://console.cloud.tencent.com/smsv2/isms-template) 的正文模板管理查看
- TemplateId: "1864019",
- /* 模板参数: 模板参数的个数需要与 TemplateId 对应模板的变量个数保持一致,若无模板参数,则设置为空 */
- TemplateParamSet,
- /* 下发手机号码,采用 e.164 标准,+[国家或地区码][手机号]
- * 示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号,最多不要超过200个手机号*/
- PhoneNumberSet,
- /* 用户的 session 内容(无需要可忽略): 可以携带用户侧 ID 等上下文信息,server 会原样返回 */
- SessionContext: "",
- /* 短信码号扩展号(无需要可忽略): 默认未开通,如需开通请联系 [腾讯云短信小助手] */
- ExtendCode: "",
- /* 国内短信无需填写该项;国际/港澳台短信已申请独立 SenderId 需要填写该字段,默认使用公共 SenderId,无需填写该字段。注:月度使用量达到指定量级可申请独立 SenderId 使用,详情请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81)。 */
- SenderId: "",
- }
- const res = await sendMessage(params);
- return res;
- }
- let code=String(100000 + Math.floor(Math.random() * 900000)); // 生成一个6位随机数字并转换为字符串
- send([code,'5'],["+8613711112222"]).then(()=>{console.log(res)});
(2)统计发送的短信数据
复制代码
- // 传入查询的时间段 偏移量和查询数量
- async function check(BeginTime,EndTime,Offset,Limit) {
- /* 请求参数 传入自己的应用id 查询的起止时间和终止时间*/
- const params = {
- // 短信应用ID: 短信SdkAppId在 [短信控制台] 添加应用后生成的实际SdkAppId,示例如1400006666
- SmsSdkAppId: "1400839034",
- // 拉取最大条数,最多100条
- Limit,
- // 偏移量 注:目前固定设置为0
- Offset,
- // 开始时间,yyyymmddhh 需要拉取的起始时间,精确到小时
- BeginTime,
- // 结束时间,yyyymmddhh 需要拉取的截止时间,精确到小时
- // 注:EndTime 必须大于 BeginTime
- EndTime,
- }
- const res = await checkMessage(params);
- return res;
- }
- check("2023071416","2023071419",0,10).then(()=>{console.log(res)});