Sign inGet Started

Verify 概述

Bird Verify 用于确认用户拥有某个邮箱地址或电话号码的控制权。请求 Bird 发送一次性验证码,在你的应用中收集该验证码,然后请求 Bird 验证是否匹配。整个流程使用两个 API 调用:POST /v1/verify/verifications 发送验证码,POST /v1/verify/verifications/check 校验验证码。Bird 的共享发送方无需注册发送方或配置模板。Email、SMS 和 WhatsApp 默认可使用 Bird Verify、Authifly 或你工作区拥有的发送方;Telegram 使用其自有的已验证通知账号。发送方与品牌设置介绍了这些选项。

验证流程

你创建一次验证时需指定接收方:邮箱地址、电话号码,或两者皆有。Bird 生成数字验证码,并通过接收方的渠道投递。邮箱地址通过邮件收到验证码;电话号码通过 SMS 或 WhatsApp 收到验证码,顺序和可用性由你的国家/地区配置为目标国家/地区所设定。用户在你的应用中输入验证码,你将其提交到校验端点,端点返回 success: true 或 false 并附带原因。
每次验证经历一个简单的生命周期:初始状态为 pending,结束状态为 verified(正确验证码在有效期内到达)、failed(错误尝试次数过多)或 expired(有效期已过)。Verifications 页面展示每次验证及其状态;各状态和原因详见发送验证。

仪表盘中的 Verify 应用

在仪表盘中,Verify 是工作区应用之一。以下是其页面及对应指南所在位置:
页面用途
Verifications工作区创建的所有验证,包含状态、接收方、渠道和时间信息;详见发送验证
Countries按国家/地区投递:使用哪些渠道、顺序如何、该国家/地区是否启用;详见国家/地区配置
Configure验证码有效期、尝试次数限制、重新发送冷却时间,以及各渠道使用的发送方;详见发送验证和发送方与品牌展示

可见性

Verifications 页面列出工作区中的所有验证,并展示每次验证的接收方、渠道计划和时间详情。通过编程方式,校验响应携带验证的当前状态。订阅 Verify 事件可获取创建、投递和验证成功的更新。列表和读取端点仅供仪表盘使用,不对外公开 API。

渠道

Verify 通过四个渠道投递验证码。接收方获得哪个渠道取决于接收方类型,对于电话号码还取决于你的国家/地区配置。
渠道接收方投递方式
Email邮箱地址从 Bird Verify 或 Authifly 共享地址发送;可随时指向你自己的已验证发送域名
SMS电话号码通过 Bird 托管的发送方或你的 Sender ID 发送,受目的地的发送方规则约束
WhatsApp电话号码通过 Bird 托管的号码或你已连接的号码发送,需使用已审批的身份验证模板
Telegram电话号码由 Telegram Gateway 投递至已注册 Telegram 的号码,来自其自有的已验证通知账号
对于电话接收方,大多数国家/地区优先尝试 WhatsApp,SMS 作为备选,但部分国家/地区默认优先使用 SMS。Telegram 在平台备选顺序中位于 SMS 之后、邮件之前。你可以按国家/地区更改顺序或关闭某个渠道。如果发送失败,投递会推进到计划中的下一个渠道。当用户反馈未收到验证码时,你也可以手动推进;详见通过其他渠道发送验证码。发送方与品牌展示展示了各消息样式和可用的发送方控制选项。

默认值与限制

你的工作区启用时使用 Bird 平台对验证码本身(长度、有效期)、校验尝试次数限制和重新发送冷却时间的默认值。每项均可在仪表盘的 Configure 中调整,验证码长度还可按请求调整;具体值和范围详见验证设置。在此之上还有你无需配置的滥用防护机制:按接收方的发送和校验上限,列于滥用防护。验证码消息默认使用接收方电话号码对应的语言,共 40 种内置翻译,options.language 可按请求覆盖。详见消息语言。

后续步骤

页面涵盖内容
发送验证发送和校验调用、状态、设置与限制
国家/地区配置启用国家/地区、设置按国家/地区的渠道顺序和发送方
发送方与品牌展示验证码消息的样式,以及如何从你自己的域名发送
事件验证生命周期与投递事件及其 webhook 载荷
身份验证API 密钥与区域主机
API 参考:创建验证发送端点的 schema 与错误详情
API 参考:校验验证码校验端点的 schema 与错误详情