自定义电子邮件和短信服务提供商
您可以自定义通知消息 IBM® Verify 的邮件发件人和短信服务商。
准备工作
如果您希望将自己的短信服务商集成到 IBM Verify 的OTP通知中,必须配置一个外部Webhook端点,该端点需能够接收来自 IBM Verify 的POST请求。 如果您还希望自定义电子邮件发件人地址,使通知看起来像是来自您自己的域名,则必须对您的电子邮件域名进行验证。
电子邮件域名验证
Email Domain Authentication 要验证您的电子邮件域名,请使用 API。 有关 API 的更多信息,请参阅 “电子邮件域验证 ”。
- 注册您的电子邮件域名。 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' - 获取您的电子邮件域名的 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' - 请验证您的电子邮件域状态。 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' - 若要更改或更新您的自定义邮箱域名,您必须先从通知中删除现有的自定义邮箱域名,然后再注册新的域名。
删除您的电子邮件验证域名。 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 是的默认电子邮件发送方和短信服务提供商。
。