npm 包 onewaysms 使用教程

阅读时长 5 分钟读完

介绍

onewaysms 是一款用于发送短信的 Node.js 模块,通过调用 onewaysms 的 API,可以实现向手机发送短信的功能。本文将详细介绍 onewaysms 的使用方法。

安装

onewaysms 可以通过 npm 安装,使用以下命令:

使用

首先,我们需要引入 onewaysms 并创建一个 SmsClient 的实例:

其中,apiKey 和 secretKey 需要在 onewaysms 的控制台中创建,具体的创建方法可以参考 onewaysms 的帮助文档

接着,我们可以通过 SmsClient 的 sendSms 方法发送短信,例如:

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

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

其中,options 可以包含如下参数:

  • senderId:短信发送者的 ID;
  • scheduleDateTime:短信发送的时间;
  • expireDateTime:短信过期的时间;
  • callbackUrl:短信发送结果回调的 URL。

更多参数的说明可以参考 onewaysms 的帮助文档

最后,我们可以通过 SmsClient 的 deleteSms 方法删除已经发送的短信,例如:

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

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

其中,messageIds 是一个包含短信 ID 的数组,可以通过 SmsClient 的 listSms 方法获取已发送的短信信息,例如:

更多方法的说明可以参考 onewaysms 的帮助文档

示例代码

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

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

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

总结

本文介绍了如何使用 onewaysms 包来发送短信,包括创建 SmsClient 实例、发送短信、获取已发送的短信信息以及删除已发送的短信。通过阅读本文,您已经了解了 onewaysms 的基本使用方法,并且可以根据需要对其进行扩展。

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

纠错
反馈