npm 包 @rduk/sms 使用教程

前言

在现代互联网应用开发中，短信服务是常用的一种验证码发送方式。而在前端开发中，如何快速地使用短信服务呢？今天我们就来介绍一款 npm 包 @rduk/sms，它是基于 Node.js 平台开发的，提供了一种简易的方式来发送短信验证码。

安装

使用 npm 安装：

npm install @rduk/sms --save

配置

在使用 @rduk/sms 之前，你需要首先获得一个短信服务的账号和密码，并确保你的短信服务商支持该库所使用的 API。

在你的项目中，你需要创建一个配置文件。文件名可以是 rduk-sms.json，并放到项目的根目录下。该文件包含一些必要的基础信息：

{
  "provider": "xx", // 短信服务商
  "username": "xxx", // 账号
  "password": "xxx", // 密码
  "signature": "xxx" // 签名，用于在不同的手机系统中显示不同的文字，如【翻译宝】
}

其中，provider 可以是 alisms，qcloudsms，huaweisms 或者 yuntongxunsms。

我们将 rduk-sms.json 作为配置项传入库中：

const SMS = require('@rduk/sms');
const config = require('./rduk-sms.json');

SMS.config(config);

发送短信

发送短信非常简单，你需要在你的项目中调用以下代码：

-- -------------------- ---- -------
----- --- - ---------------------

----- ------- - -
  ------------- ---------------- -- ----------
  ------------- ---------------- -- --------------
  -------------- - -- --------
    ----- --------
  -
--

-----------------
  --------- -- -----------------
  ---------- -- --------------------

在示例中，我们发送的验证码是 123456。通过模板参数，我们可以轻松地完成短信发送。

深入了解

@rduk/sms 不仅支持发送普通的文字内容，还支持更多的功能，例如短信模板。你可以在短信服务商的平台上申请并创建一个短信模板。

const options = {
  phoneNumbers: ['12345678901'],
  templateCode: 'SMS_123456789',
  templateParam: {
    code: '123456'
  }
};

我们使用 templateCode 和 templateParam 属性指定了使用特定的短信模板和短信模板中需要替换的变量。

@rduk/sms 还支持发送超长短信（长度超过 70 个字符的短信），需要注意的是，发送超长短信会占用多条计费短信通道。

const options = {
  phoneNumbers: ['12345678901'],
  content: '这是一条超长短信…………'
};

总结

@rduk/sms 是一款基于 Node.js 开发的 npm 包，提供了简易、灵活的方式来发送短信验证码。配置简单，使用方便，非常适合需要短信发送功能的应用开发。希望本文能够帮助你快速了解和使用该包。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005672281e8991b448e393b