用途
Telnyx Verify - Ruby 是 Telnyx 官方 Ruby SDK 中与 Verify 相关的技能,用于两类任务:一是查询电话号码信息(运营商、号码类型、来电显示名称等),二是通过短信、语音、闪呼、WhatsApp 等渠道向用户发送并校验 OTP 验证码,实现电话号码验证与数据补充。
主要能力
- 电话号码查询:返回 caller_name、carrier、country_code、fraud、national_format、phone_number、portability、record_type 等信息。
- 验证管理:按电话号码列出验证记录、按 ID 检索验证、按电话号码或 ID 校验验证码。
- 触发验证:支持 SMS、Call、Flash call、WhatsApp 四种验证方式,可指定 custom_code、extension、timeout_secs 等可选参数。
- Verify 配置文件:创建、检索、更新、删除 Verify profile,支持配置 call、sms、flashcall、whatsapp、language、daily_spend_limit、webhook_url、webhook_failover_url 等。
- 消息模板:列出、创建、更新 Verify profile 消息模板,模板文本支持 {{app_name}}、{{code}} 等占位符。
使用方式
安装:
gem install telnyx
初始化:
require "telnyx"
client = Telnyx::Client.new( api_key: ENV["TELNYX_API_KEY"], # This is the default and can be omitted )
错误处理:所有 API 调用都可能因网络错误、速率限制(429)、校验错误(422)或认证错误(401)而失败,生产代码中应始终处理错误。常见错误码:401 无效 API key,403 权限不足,404 资源未找到,422 校验错误(检查字段格式),429 速率限制(使用指数退避重试)。
重要说明:电话号码必须使用 E.164 格式(例如 +13125550001),包含 + 前缀和国家代码,不能有空格、短横线或括号。分页可使用 .auto_paging_each 自动迭代:page.auto_paging_each { |item| puts item.id }。
适用场景
- 在 Ruby 应用中集成电话号码验证流程(注册、登录、二次验证等)。
- 对用户电话号码进行数据补充,获取运营商、号码类型、来电显示名称等信息。
- 通过多种渠道(SMS、语音、闪呼、WhatsApp)发送 OTP 验证码。
- 管理 Verify 配置文件与消息模板,统一验证策略与文案。
限制
- 电话号码必须为 E.164 格式。
- 需要有效的 Telnyx API key。
- 部分接口需要 verify_profile_id 等必填参数。
- 关于收费、价格、平台支持范围、具体效果等事实,资料中暂未提供。