npm 包 aliyun-sms-sdk 使用教程

阅读时长 4 分钟读完

背景

在开发前端应用的过程中,我们常常需要使用短信服务来完成验证码、普通短信等功能。而阿里云是一个领先的云计算服务提供商,其提供了短信服务,其中 aliyun-sms-sdk 是其官方提供的 Node.js SDK,可通过 npm 直接安装并使用。

本文将介绍如何使用 aliyun-sms-sdk 实现短信服务,并提供详细的指导和示例代码。

安装 aliyun-sms-sdk

安装 aliyun-sms-sdk 非常简单,只需要使用 npm 命令即可:

使用 aliyun-sms-sdk

申请阿里云短信服务

在使用 aliyun-sms-sdk 之前,需要先在阿里云上申请短信服务并获取 AccessKey 和 Secret。

AccessKey 和 Secret 是访问阿里云资源的重要凭证,需妥善保管,如有泄漏风险请及时处理。

发送短信

短信服务的核心功能是发送短信,在 aliyun-sms-sdk 中,我们可以通过如下方式发送短信:

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

代码中:

  • PhoneNumbers:接收短信的手机号码,支持多个手机号码,以英文逗号(,)分隔,且必须为 String 类型。
  • SignName:短信签名名称,需在阿里云短信服务中先申请并审核通过,且必须为 String 类型。
  • TemplateCode:短信模板CODE,需在阿里云短信服务中先申请并审核通过,且必须为 String 类型。
  • TemplateParam:短信模板变量,JSON 格式,具体内容由短信模板决定,且必须为 String 类型。

需要注意的是,代码中的内容需替换成自己的 AccessKey 和 Secret,以及手机号码、短信签名名称、短信模板CODE 和模板变量等相关内容。

查询发送短信状态

发送短信后,我们通常需要查询其发送状态。在 aliyun-sms-sdk 中,我们可以通过如下方式查询。

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

代码中:

  • PhoneNumber:接收短信的手机号码,支持单个手机号码,且必须为 String 类型。
  • SendDate:短信发送日期,格式为yyyyMMdd,且必须为 String 类型。
  • PageSize:分页大小,最大值为100,且必须为 Number 类型。
  • CurrentPage:当前页码,且必须为 Number 类型。

同样,需将代码中的内容替换成实际数据。

总结

通过本文的介绍,我们了解了如何使用 aliyun-sms-sdk 实现短信服务,并提供了详细的指导和示例代码。希望本文能够为有需要的开发者提供帮助和指导,并提高开发效率和质量。

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

纠错
反馈