Look up phone number information (carrier, type, caller name) and verify users via SMS/voice OTP. Use for phone verification and data enrichment. This skill provides Ruby SDK examples.
中文简介正在准备中。当前显示原文说明。
实测评分 未实测
查看安装方法安装前可以查看交给 AI 代理的指令内容。
gem install telnyx
require "telnyx"
client = Telnyx::Client.new(
api_key: ENV["TELNYX_API_KEY"], # This is the default and can be omitted
public_key: ENV["TELNYX_PUBLIC_KEY"], # Required for client.webhooks.unwrap (webhook verification)
)
All examples below assume client is already initialized as shown above.
All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:
begin
result = client.messages.send_(to: "+13125550001", from: "+13125550002", text: "Hello")
rescue Telnyx::Errors::APIConnectionError
puts "Network error — check connectivity and retry"
raise
rescue Telnyx::Errors::RateLimitError
# 429: rate limited — wait, then retry the request (bounded exponential backoff)
sleep(1) # Check Retry-After header for actual delay
# ...retry the call here (give up after a few attempts); otherwise re-raise:
raise
rescue Telnyx::Errors::APIStatusError => e
puts "API error #{e.status}: #{e.message}"
if e.status == 422
puts "Validation error — check required fields and formats"
end
raise # A failed request must never look like success to the caller
end
Common error codes: 401 invalid API key, 403 insufficient permissions,
404 resource not found, 422 validation error (check field formats),
429 rate limited (retry with exponential backoff).
+13125550001). Include the + prefix and country code. No spaces, dashes, or parentheses..auto_paging_each for automatic iteration: page.auto_paging_each { |item| puts item.id }.Returns information about the provided phone number.
GET /number_lookup/{phone_number}
number_lookup = client.number_lookup.retrieve("+18665552368")
puts(number_lookup)
Returns: caller_name (object), carrier (object), country_code (string), fraud (string | null), national_format (string), phone_number (string), portability (object), record_type (string)
Returns a paginated list of verifications associated with the specified phone number.
GET /verifications/by_phone_number/{phone_number}
by_phone_numbers = client.verifications.by_phone_number.list("+13035551234")
puts(by_phone_numbers)
Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall, whatsapp), updated_at (string), verify_profile_id (uuid)
Submits a verification code for the specified phone number and Verify profile. The response indicates whether the code was accepted or rejected.
POST /verifications/by_phone_number/{phone_number}/actions/verify — Required: code, verify_profile_id
verify_verification_code_response = client.verifications.by_phone_number.actions.verify(
"+13035551234",
code: "17686",
verify_profile_id: "12ade33a-21c0-473b-b055-b3c836e1c292"
)
puts(verify_verification_code_response)
Returns: phone_number (string), response_code (enum: accepted, rejected)
Starts a verification for the specified phone number and delivers its code in a voice call using the selected Verify profile. Returns the pending verification record.
POST /verifications/call — Required: phone_number, verify_profile_id
Optional: custom_code (string | null), extension (string | null), timeout_secs (integer)
create_verification_response = client.verifications.trigger_call(
phone_number: "+13035551234",
verify_profile_id: "12ade33a-21c0-473b-b055-b3c836e1c292"
)
puts(create_verification_response)
Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall, whatsapp), updated_at (string), verify_profile_id (uuid)
Starts a verification for the specified phone number and places a brief call with the code embedded in the caller ID. Returns the pending verification record.
POST /verifications/flashcall — Required: phone_number, verify_profile_id
Optional: timeout_secs (integer)
create_verification_response = client.verifications.trigger_flashcall(
phone_number: "+13035551234",
verify_profile_id: "12ade33a-21c0-473b-b055-b3c836e1c292"
)
puts(create_verification_response)
Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall, whatsapp), updated_at (string), verify_profile_id (uuid)
Starts a verification for the specified phone number and sends its code by SMS using the selected Verify profile. Returns the pending verification record.
POST /verifications/sms — Required: phone_number, verify_profile_id
Optional: custom_code (string | null), timeout_secs (integer)
create_verification_response = client.verifications.trigger_sms(
phone_number: "+13035551234",
verify_profile_id: "12ade33a-21c0-473b-b055-b3c836e1c292"
)
puts(create_verification_response)
Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall, whatsapp), updated_at (string), verify_profile_id (uuid)
Starts a verification for the specified phone number and sends its code over WhatsApp using the selected Verify profile. Returns the pending verification record.
POST /verifications/whatsapp — Required: phone_number, verify_profile_id
Optional: custom_code (string | null), timeout_secs (integer)
create_verification_response = client.verifications.trigger_whatsapp_verification(
phone_number: "+13035551234",
verify_profile_id: "12ade33a-21c0-473b-b055-b3c836e1c292"
)
puts(create_verification_response)
Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall, whatsapp), updated_at (string), verify_profile_id (uuid)
Returns the verification identified by ID, including its channel, phone number, Verify profile, timeout, and current status.
GET /verifications/{verification_id}
verification = client.verifications.retrieve("12ade33a-21c0-473b-b055-b3c836e1c292")
puts(verification)
Returns: created_at (string), custom_code (string | null), id (uuid), phone_number (string), record_type (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeout_secs (integer), type (enum: sms, call, flashcall, whatsapp), updated_at (string), verify_profile_id (uuid)
Checks the supplied code, or the supplied status for a custom-code verification, against the verification identified by ID. The response indicates whether the verification was accepted or rejected.
POST /verifications/{verification_id}/actions/verify
Optional: code (string), status (enum: accepted, rejected)
verify_verification_code_response = client.verifications.actions.verify("12ade33a-21c0-473b-b055-b3c836e1c292", code: "12345")
puts(verify_verification_code_response)
Returns: phone_number (string), response_code (enum: accepted, rejected)
Gets a paginated list of Verify profiles.
GET /verify_profiles
page = client.verify_profiles.list
puts(page)
Returns: call (object), created_at (string), daily_spend_limit (number), daily_spend_limit_enabled (boolean), flashcall (object), id (uuid), language (string), name (string), record_type (enum: verification_profile), sms (object), updated_at (string), webhook_failover_url (string), webhook_url (string), whatsapp (object)
Creates a new Verify profile to associate verifications with.
POST /verify_profiles — Required: name
Optional: call (object), daily_spend_limit (number), daily_spend_limit_enabled (boolean), flashcall (object), language (string), sms (object), webhook_failover_url (string), webhook_url (string), whatsapp (object)
verify_profile_data = client.verify_profiles.create(name: "Test Profile")
puts(verify_profile_data)
Returns: call (object), created_at (string), daily_spend_limit (number), daily_spend_limit_enabled (boolean), flashcall (object), id (uuid), language (string), name (string), record_type (enum: verification_profile), sms (object), updated_at (string), webhook_failover_url (string), webhook_url (string), whatsapp (object)
List all Verify profile message templates.
GET /verify_profiles/templates
response = client.verify_profiles.retrieve_templates
puts(response)
Returns: id (uuid), text (string)
Create a new Verify profile message template.
POST /verify_profiles/templates — Required: text
message_template = client.verify_profiles.create_template(text: "Your {{app_name}} verification code is: {{code}}.")
puts(message_template)
Returns: id (uuid), text (string)
Update an existing Verify profile message template.
PATCH /verify_profiles/templates/{template_id} — Required: text
message_template = client.verify_profiles.update_template(
"12ade33a-21c0-473b-b055-b3c836e1c292",
text: "Your {{app_name}} verification code is: {{code}}."
)
puts(message_template)
Returns: id (uuid), text (string)
Returns the details of a single Verify profile by its ID, including its verification channel configuration.
GET /verify_profiles/{verify_profile_id}
verify_profile_data = client.verify_profiles.retrieve("12ade33a-21c0-473b-b055-b3c836e1c292")
puts(verify_profile_data)
Returns: call (object), created_at (string), daily_spend_limit (number), daily_spend_limit_enabled (boolean), flashcall (object), id (uuid), language (string), name (string), record_type (enum: verification_profile), sms (object), updated_at (string), webhook_failover_url (string), webhook_url (string), whatsapp (object)
Updates the specified Verify profile's name, webhook destinations, language, daily spend limits, or channel-specific settings. Returns the updated profile.
PATCH /verify_profiles/{verify_profile_id}
Optional: call (object), daily_spend_limit (number), daily_spend_limit_enabled (boolean), language (string), name (string), sms (object), webhook_failover_url (string), webhook_url (string), whatsapp (object)
verify_profile_data = client.verify_profiles.update("12ade33a-21c0-473b-b055-b3c836e1c292")
puts(verify_profile_data)
Returns: call (object), created_at (string), daily_spend_limit (number), daily_spend_limit_enabled (boolean), flashcall (object), id (uuid), language (string), name (string), record_type (enum: verification_profile), sms (object), updated_at (string), webhook_failover_url (string), webhook_url (string), whatsapp (object)
Deletes the specified Verify profile and returns the deleted profile record.
DELETE /verify_profiles/{verify_profile_id}
verify_profile_data = client.verify_profiles.delete("12ade33a-21c0-473b-b055-b3c836e1c292")
puts(verify_profile_data)
Returns: call (object), created_at (string), daily_spend_limit (number), daily_spend_limit_enabled (boolean), flashcall (object), id (uuid), language (string), name (string), record_type (enum: verification_profile), sms (object), updated_at (string), webhook_failover_url (string), webhook_url (string), whatsapp (object)
还没有评价。欢迎分享你的使用感受。
无需登录即可发表。欢迎分享使用感受、提问，或说明在哪些环境下无法运行。
还没有评论。来写第一条吧。
Test VoIP push notifications for Telnyx WebRTC iOS (APNs) and Android (FCM) apps. Use when debugging push notification delivery, validating certificate/credential setup, or testing that a device receives VoIP pushes correctly.
中文简介正在准备中。当前显示原文说明。
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
中文简介正在准备中。当前显示原文说明。
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
中文简介正在准备中。当前显示原文说明。
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
中文简介正在准备中。当前显示原文说明。
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
中文简介正在准备中。当前显示原文说明。
10DLC brand and campaign registration for US A2P messaging compliance. Assign phone numbers to campaigns.
中文简介正在准备中。当前显示原文说明。