跳到主要内容

使用阿里云短信服务设置短信验证

Logto 官方的阿里云短信服务连接器。

提示:

本指南假设你对 Logto 连接器 (Connectors) 有基本的了解。对于不熟悉的人,请参考 连接器 (Connectors) 指南以开始了解。

开始使用

阿里云是亚洲主要的云服务提供商之一,提供包括短信(短消息服务)在内的多种云服务。阿里云短信连接器是 Logto 团队提供的一个插件,借助它,Logto 终端用户可以通过短信验证码注册和登录他们的 Logto 账户。

在阿里云短信控制台设置短消息服务

创建阿里云账户

如果你还没有阿里云账户,请访问 阿里云网站并注册你的阿里云账户。

启用并配置阿里云短信服务

  1. 使用你的阿里云账户登录 阿里云网站,并进入 短信服务控制台页面
  2. 点击短信服务页面左上角的“免费开通”按钮,开始配置过程。
  3. 阅读并同意“短信服务开通条款”,然后点击“开通服务”继续。
  4. 现在你在 短信服务控制台页面,根据你的使用情况,进入侧边栏的“国内消息”或“国际/港澳台消息”按钮。
  5. 按照指南添加签名和模板,并提供审核所需的材料或信息。
    • 在填写签名申请时,记得选择“验证码”作为“适用场景”,在申请模板审核时也选择“验证码”作为“模板类型”,因为我们使用这些签名和模板发送验证码。目前,我们不支持发送除验证码相关文本消息以外的短信。
    • 在模板内容中使用 {{code}} 作为占位符,以放置你的数字验证码。
  6. 提交你的短信签名和模板申请后,你需要等待其生效。此时,我们可以返回 短信服务控制台页面 并发送测试短信。如果你的签名和模板已准备好使用,你可以直接尝试;如果它们尚未生效,阿里云也提供测试模板。
    • 你可能需要在发送测试消息之前充值少量金额。
    • 你可能还需要在发送测试消息之前绑定一个测试电话号码。有关更多详细信息,请访问 短信服务控制台页面 侧边栏的“快速学习”选项卡。

编写连接器 JSON

  1. 短信服务控制台页面,将鼠标悬停在右上角的头像上,进入“AccessKey 管理”,并点击“创建 AccessKey”。完成安全验证后,你将获得一对“AccessKey ID”和“AccessKey Secret”。请妥善保管。
  2. 进入你刚访问的“国内消息”或“国际/港澳台消息”选项卡,你可以轻松找到“签名名称”和“模板 CODE”。
    • 如果你想使用仅用于测试的签名和模板,请转到“快速学习”选项卡,你将在“签名和模板(仅用于测试)”下找到它们。
  3. 填写阿里云短信连接器设置:
    • 使用步骤 1 中获得的访问密钥对填写 accessKeyIdaccessKeySecret 字段。
    • 使用步骤 2 中提到的“签名名称”填写 signName 字段。所有模板将共享此签名名称。
    • 你可以为不同的情况添加多个短信连接器模板。以下是添加单个模板的示例:
      • 使用步骤 2 中的“模板 CODE”填写 templateCode 字段,以控制短信内容。
      • 根据不同的使用场景,使用 RegisterSignInForgotPasswordGeneric 填写 usageType 字段。(usageType 是 Logto 属性,用于识别适当的使用场景。)为了启用完整的用户流程,需要具有 RegisterSignInForgotPasswordGeneric 的 usageType 的模板。

测试阿里云短信连接器

你可以输入一个电话号码并点击“发送”以查看设置是否可以在“保存并完成”之前工作。

就是这样。别忘了在 登录体验中启用连接器

配置类型

名称类型
accessKeyIdstring
accessKeySecretstring
signNamestring
templatesTemplate[]
模板属性类型枚举值
templateCodestringN/A
usageTypeenum string'Register' | 'SignIn' | 'ForgotPassword' | 'Generic'

参考资料