介绍
shgbit-ali-sms-api 是一个基于 Node.js 平台的阿里云短信服务 API 的封装 npm 包。
通过该 npm 包,开发者可以轻松的调用阿里云短信服务 API,发送短信、查询短信发送记录等操作。
安装
使用 npm 安装 shgbit-ali-sms-api:
npm install shgbit-ali-sms-api --save
使用
在使用 shgbit-ali-sms-api 之前,需要在阿里云官网进行授权管理,获取 AccessKey 和 AccessKeySecret。
- 引入 shgbit-ali-sms-api
const SMS = require("shgbit-ali-sms-api");
- 实例化 SMS 类
const sms = new SMS('AccessKey', 'AccessKeySecret');
- 发送短信
-- -------------------- ---- ------- ----- ------ - - ------------- -------------- --------- ------- ------------- ----------- -------------- ------------------- - ---------------- --------- -- - ----------------- -- ---------- -- - ----------------- ---
参数说明:
PhoneNumbers
:接收短信的手机号码,支持单个和多个手机号码,多个手机号码之间用英文逗号 ',' 分隔。SignName
:短信签名名称,必须在阿里云短信控制台中申请并审核通过。TemplateCode
:短信模板的模板 Code,必须在阿里云短信控制台中申请并审核通过。TemplateParam
:短信模板中的变量参数,需要通过 JSON 格式字符串进行传递。例如: '{"code":"123456"}'。
- 查询短信发送记录
-- -------------------- ---- ------- ----- ------ - - ------------ -------------- --------- ---------- - ----------------- --------- -- - ----------------- -- ---------- -- - ----------------- ---
参数说明:
PhoneNumber
:接收短信的手机号码。SendDate
:短信发送日期,格式为 YYYYMMDD,例如:20221212。
总结
通过 shgbit-ali-sms-api,我们可以轻松调用阿里云短信服务 API,实现短信发送和查询等操作。在开发过程中,需要注意调用 API 的参数和返回值格式,确保安全可靠的短信服务。
示例代码参考:
-- -------------------- ---- ------- ----- --- - ------------------------------ ----- --- - --- ---------------- ------------------- ----- ------ - - ------------- -------------- --------- ------- ------------- ----------- -------------- ------------------- - ---------------- --------- -- - ----------------- -- ---------- -- - ----------------- --- ----- ------------ - - ------------ -------------- --------- ---------- - ----------------------- --------- -- - ----------------- -- ---------- -- - ----------------- ---
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055d2c81e8991b448dae41