自定义电子邮件和短信服务提供商

您可以自定义通知消息 IBM® Verify 的邮件发件人和短信服务商。

准备工作

如果您希望将自己的短信服务商集成到 IBM Verify 的OTP通知中,必须配置一个外部Webhook端点,该端点需能够接收来自 IBM Verify 的POST请求。 如果您还希望自定义电子邮件发件人地址,使通知看起来像是来自您自己的域名,则必须对您的电子邮件域名进行验证。

电子邮件域名验证

Email Domain Authentication 要验证您的电子邮件域名,请使用 API。 有关 API 的更多信息,请参阅 “电子邮件域验证 ”。

  1. 注册您的电子邮件域名。 https://{tenanturl}/config/v1.0/email-domain-auth
    示例
    curl --request POST \
         --url https://tenant_url/config/v1.0/email-domain-auth \
         --header 'accept: application/json' \
         --header 'content-type: application/json'
  2. 获取您的电子邮件域名的 DNS 记录。 https://{tenanturl}/config/v1.0/email-domain-auth/{domain}
    示例
    curl --request GET \
         --url https://tenant_url/config/v1.0/email-domain-auth/domain \
         --header 'accept: application/json'
  3. 请验证您的电子邮件域状态。 https://{tenanturl}/config/v1.0/email-domain-auth/{domain}/verify
    示例
    curl --request POST \
         --url https://tenant_url/config/v1.0/email-domain-auth/domain/verify \
         --header 'accept: application/json'
  4. 若要更改或更新您的自定义邮箱域名,您必须先从通知中删除现有的自定义邮箱域名,然后再注册新的域名。

    删除您的电子邮件验证域名。 https://{tenanturl}/config/v1.0/email-domain-auth/{domain}

    示例
    curl --request DELETE \
         --url https://tenant_url/config/v1.0/email-domain-auth/domain \
         --header 'accept: application/json'
外部 webhook 的设置要求
  • IBM Verify外部短信服务提供商必须公开一个 HTTP POST 网络钩子端点,以接收来自 的 OTP 通知请求。
  • 该端点必须立即将请求放入队列,并返回 HTTP 响应。
JSON 请求负载示例
{
  "destinationPhoneNumber": "18005551212",
  "content": "Your passcode is 6439-123456. It expires in 5 minutes.",
  "category": "OTP",
  "language": "en-US",
  "otp": "123456",
  "correlation": "6439",
  "expiry": 5
}
字段级描述
destinationPhoneNumber
收件人的电话号码,格式为 E.164。
content
向用户显示的完整短信内容。
category
OTP
language
区域设置或语言代码,例如 en-US。
otp
一次性密码的值。
correlation
用于将一次性密码(OTP)与验证流程关联的标识符;通常显示在消息中。
expiry
有效期(以分钟为单位)。
Webhook 响应要求
202 已接受
请求已成功加入队列。
400 错误的请求
有效载荷格式无效。
500 内部服务器错误
服务提供商无法处理。
成功响应示例
{
"status": "accepted",
"statusMessage": "Message accepted by provider"
}
失败响应示例
{
"status": "failed",
"statusMessage": "The destination phone number is invalid."
}

关于此任务

VerifyIBM 是的默认电子邮件发送方和短信服务提供商。

过程

  1. 转到 “全局配置 ”> “通信 ”,然后选择 “发件人 ”选项卡。
  2. 要更改邮件发件人,请点击 “邮件 ”磁贴上的图标 画笔
    1. 更改以下电子邮件选项的默认值。
      表1。

      该表描述了电子邮件通知的属性。

      属性 描述
      发件人地址 更改此字段以反映要将其列为此通知的发件人的电子邮件地址。
      发件人电子邮件名称 更改此字段以反映发送该通知的个人或组织。 例如,您的公司。
    2. 可选: 选中 “使用自定义 SMTP 邮件服务器 ”复选框。
      对于定制 SMTP 服务器,指定以下信息:
      • SMTP 主机
      • 端口
      • 用户名
      • 密码
      • 选择连接协议(TLS 或 SSL)。
    3. 点击 “保存”
  3. 如果您的租户正在使用 IBM 的短信服务,且您希望更改短信发件人 ID,请点击短信服务提供商磁贴上的 图标 画笔
    您可以修改该属性,使其符合贵公司或贵组织的情况。
    1. 更改以下选项的默认值。
      表2。

      该表描述了短信通知的属性。

      属性 描述
      字母数字发送方标识 更改此字段以反映标识消息发件人的字母数字标识(A-Z、a-z 和 0-9)。 该值必须以字母字符开头,不能包含空格或特殊字符,且最多包含 11 个字符。
      注意: Verify 不支持短信功能。
    2. 点击 “保存更改 ”。
  4. 如果您的租户未使用 IBM 短信服务,且您希望使用外部短信服务提供商,请在“短信服务提供商 ”磁贴上点击 “添加外部短信服务提供商”
    1. 请为短信服务商命名。
      您还可指定所有者和电子邮件联系人信息。
    2. 请指定请求 URL。
      URL 指向通知服务用于发送短信时调用的外部短信提供商端点。
    3. 选择认证的类型。
      基本
      指定用户名和密码。
      页眉
      指定标头名称和认证私钥。 如果私钥是区分大小写的,请选中区分大小写复选框。
      不需要认证信息。
      OAuth
      指定令牌端点。 请选择客户端密钥是 POST 还是 Basic。 请输入客户端 ID 和密钥。
      注: 客户端的帖子显示,该密钥是以属性的形式存储的。 客户机 basic 指示私钥存储在标头中。
      JSON Web 令牌 (JWT)
      请指定 HTTP 标头值、子声明、JWT的最大有效期以及签名算法。 如果需要,您还可以指定 JWT 标头值前缀、JWT 标头键以及声明名称。
      Mutual TLS ( mTLS )
      指定 MTLS 证书标签。
    1. 点击 “保存”
      短信服务提供商已创建,但默认处于禁用状态。
    2. 请测试您的租户是否已连接到您的短信服务提供商,点击 “测试连接 ”。
      您可以向短信服务商发送一条测试消息,以测试连接是否正常。
    3. 连接测试成功后,当您准备好使用外部短信服务提供商时,请点击 “配置 ”开关将其启用。
    4. 可选: 要查看短信服务提供商的状态,请点击 “查看运行状况统计 ”。
      健康状态页面提供了SMS服务商 URL 的连接摘要、连接历史记录及统计数据