npm 包 @rduk/sms-messagebird 使用教程

阅读时长 6 分钟读完

简介

@rduk/sms-messagebird 是一个 Node.js 的 npm 包,封装了 MessageBird 的短信服务接口,可以方便地在 Node.js 项目中发送短信。本文详细介绍了如何使用该包。

安装

可以使用 npm 安装该包,命令行:npm install @rduk/sms-messagebird

使用

请确保已经注册了 MessageBird 服务并拥有 API_KEY。初始化包需要传递 api key 和一个选项对象。选项对象中可以定义一些默认配置,如 sender、reference 以及其他 MessageBird API 中的参数。

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

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

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

该代码片段将发送一条短信给荷兰号码 31612345678,短信内容为 Hello MessageBird!

在选项对象中,还可以定义全局回调函数回调 ,该回调函数将在短信发送后按照全局设置回调函数调用。

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

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

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

该代码片段定义了一个全局事件回调函数,可以在静默失败、发送超时和成功发送之后的各个时刻执行。

测试

为了测试这个包的功能,我们可以使用 MessageBird 提供的 API 模拟器。该模拟器对所有 API 请求作出响应,并生成常用的事件 (timeouts、errors、delivery reports)。我们可以通过 options 对象来将 URL 改为 http://localhost

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

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

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

现在,我们可以使用 Docker 命令行运行 MessageBird 的模拟器:

统计

在 MessageBird 的网站上,我们可以查看最新的短信和响应状态。在本地,也可以通过 eventSource 注册全局事件监听器来获得实时状态:

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

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

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

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

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

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

结论

@rduk/sms-messagebird 是一个很有用的 npm 包,可用于在 Node.js 项目中方便地发送短信。使用本文提供的代码片段和示例,可以轻松地将该包集成到项目中。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600568d281e8991b448e4925

纠错
反馈