uniCloud云函数接入腾讯云短信服务(v3鉴权)
2022-03-08 本文已影响0人
略懂一点html
准备工作:
- 腾讯云API密钥(SecretId和SecretKey)
获取方法:登录腾讯云--->鼠标移到右上角头像--->选择访问管理-->访问密钥-->API密钥管理-->新建密钥
- 短信应用SDK AppID
获取方法:控制台->短信->应用管理->应用列表->新建应用->SDK AppID
实例
- 云函数内使用示例
const { mainCodeV3 } = require('公共模块的V3鉴权封装名称')
exports.main = async (event, context) => {
const url = "https://sms.tencentcloudapi.com/" // 腾讯云短信服务的api地址
// 需要的发送请求参数
let phoneNum = "+86" + {手机号码}
let payload = {
"PhoneNumberSet": [phoneNum], // phoneNum: 手机号 (String) 格式为 `+86${phoneNum}`
"SmsSdkAppId": "********", // SDK AppID
"SignName": "******", // 短信签名内容(不是签名ID) 可在短信控制台-签名管理查看,没有的话创建一个,需要审核,一般在1天内就审核完成了
"TemplateParamSet": [String], // 类似正文模板内的{1}自定义内容: 验证码为:{1},您正在登录,若非本 人操作,请勿泄露。
"TemplateId":"" // 正文模板的ID 可在短信控制台正文模板管理内查询
}
// 使用我们封装的鉴权方法,将需要的参数传入
/**
return Object
Authorization: 鉴权内容
time: 时间戳
*/
let info = await mainCodeV3(payload)
// 调用云开发的请求方法
const sendres = await uniCloud.httpclient.request(url,
{
headers: {
"Content-Type": "application/json",
"Authorization": info.Authorization, // 鉴权获得的内容
"Host": "sms.tencentcloudapi.com",
"X-TC-Action": "SendSms",
"X-TC-Version": "2021-01-11",
"X-TC-Timestamp": Number(info.time), // 封装函数获得的时间戳,一定要是Number类型
"X-TC-Region": "ap-guangzhou"
},
data: payload, // 未鉴权的参数
method: 'POST',
dataType:"json",
})
console.log('请求后的返回内容->',sendres); // 自行在里面提取参数判断是否发送成功
}
- V3鉴权js封装(在uniCloud云开发环境-common目录->新建公共函数-放入该内容)
const crypto = require('crypto'); // 云开发环境默认有这个加解密库,直接导入使用即可,无需安装
// service :默认为sms短信服务 可根据腾讯云文档改成其他服务(通用鉴权)
// payload: 需传入该服务需要的参数
async function mainCodeV3(payload,service = 'sms'){
var SecretId = "*************"; // // SecretId, 需要替换为自己的
var SecretKey = "***********"; // SecretKey, 需要替换为自己的
// 1. 拼接规范请求串 CanonicalRequest
var HTTPRequestMethod = 'POST'; // HTTP 请求方法(GET、POST )。此示例取值为 POST
var CanonicalURI = '/'; // URI 参数,API 3.0 固定为正斜杠(/)
var CanonicalQueryString = ""; // POST请求时为空 // 内
var CanonicalHeaders = "content-type:application/json\nhost:" + service + ".tencentcloudapi.com\n"; // sms.tencentcloudapi.com需要修改前缀短信为:sms
var SignedHeaders = "content-type;host";
// 传入需要做 HTTP 请求的正文 body
var HashedRequestPayload = crypto.createHash('sha256').update(JSON.stringify(payload)).digest('hex');
// 拼接
var CanonicalRequest = HTTPRequestMethod + '\n' +
CanonicalURI + '\n' +
CanonicalQueryString + '\n' +
CanonicalHeaders + '\n' +
SignedHeaders + '\n' +
HashedRequestPayload;
// 2. 拼接待签名字符串
var Algorithm = "TC3-HMAC-SHA256"; // 签名算法,目前固定为 TC3-HMAC-SHA256
var RequestTimestamp = Math.round(new Date().getTime()/1000) + ""; // 请求时间戳,即请求头部的公共参数 X-TC-Timestamp 取值,取当前时间 UNIX 时间戳,精确到秒
var t = new Date();
var date = t.toISOString().substr(0, 10); // 计算 Date 日期 date = "2021-10-07"
/**
* Date 必须从时间戳 X-TC-Timestamp 计算得到,且时区为 UTC+0。
* 如果加入系统本地时区信息,例如东八区,将导致白天和晚上调用成功,但是凌晨时调用必定失败。
* 假设时间戳为 1551113065,在东八区的时间是 2019-02-26 00:44:25,但是计算得到的 Date 取 UTC+0 的日期应为 2019-02-25,而不是 2019-02-26。
* Timestamp 必须是当前系统时间,且需确保系统时间和标准时间是同步的,如果相差超过五分钟则必定失败。
* 如果长时间不和标准时间同步,可能导致运行一段时间后,请求必定失败,返回签名过期错误。
*/
var CredentialScope = date + "/"+ service +"/tc3_request"; // sms为腾讯云短信服务-其他服务根据文档修改
/**
* 拼接 CredentialScope 凭证范围,格式为 Date/service/tc3_request ,
* service 为服务名,慧眼用 faceid , OCR 文字识别用 ocr
*/
// 将第一步拼接得到的 CanonicalRequest 再次进行哈希加密
var HashedCanonicalRequest = crypto.createHash('sha256').update(CanonicalRequest).digest('hex');
// 拼接
var StringToSign = Algorithm + '\n' +
RequestTimestamp + '\n' +
CredentialScope + '\n' +
HashedCanonicalRequest;
// 3. 计算签名
var SecretDate = crypto.createHmac('sha256', "TC3"+SecretKey).update(date).digest();
var SecretService = crypto.createHmac('sha256', SecretDate).update(service).digest(); // 注意修改sms
var SecretSigning = crypto.createHmac('sha256', SecretService).update("tc3_request").digest();
var Signature = crypto.createHmac('sha256', SecretSigning).update(StringToSign).digest('hex');
// 4. 拼接Authorization
var Algorithm = "TC3-HMAC-SHA256";
var Authorization =
Algorithm + ' ' +
'Credential=' + SecretId + '/' + CredentialScope + ', ' +
'SignedHeaders=' + SignedHeaders + ', ' +
'Signature=' + Signature
return {
Authorization,
time: RequestTimestamp
}
}
// 导出方法
/**
* Authorization 鉴权
* time: 当前时间戳
*/
module.exports = {
mainCodeV3
}