Como usar
- Copie o comando e verifique o pacote antes de instalar no seu ambiente de agente.
- Consulte no original as ferramentas, credenciais e ambientes necessários.
- Descreva os dados de entrada e a entrega esperada; confira a saída com as fontes.
npx skills add https://github.com/team-telnyx/ai --skill telnyx-verify-rubyAntes de começar
- A instalação não inclui assinatura de modelo, franquia API ou acesso aos seus arquivos.
- Estrelas e instalações indicam atividade, não um teste independente de qualidade ou segurança.
Renderizado do repositório de origem, preservando títulos, exemplos, código, tabelas, links e imagens.
<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->
Telnyx Verify - Ruby
Installation
gem install telnyxSetup
require "telnyx"
client = Telnyx::Client.new(
api_key: ENV["TELNYX_API_KEY"], # This is the default and can be omitted
)All examples below assume client is already initialized as shown above.
Error Handling
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"
rescue Telnyx::Errors::RateLimitError
# 429: rate limited — wait and retry with exponential backoff
sleep(1) # Check Retry-After header for actual delay
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
endCommon 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).
Important Notes
- Phone numbers must be in E.164 format (e.g.,
+13125550001). Include the+prefix and country code. No spaces, dashes, or parentheses. - Pagination: Use
.auto_paging_eachfor automatic iteration:page.auto_paging_each { |item| puts item.id }.
Lookup phone number data
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)
List verifications by 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)
Verify verification code by phone number
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)
Trigger Call verification
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)
Trigger Flash call verification
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)
Trigger SMS verification
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)
Trigger WhatsApp verification
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)
Retrieve verification
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)
Verify verification code by ID
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")
puts(verify_verification_code_response)Returns: phone_number (string), response_code (enum: accepted, rejected)
List all Verify profiles
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: verificationprofile), `sms` (object), `updatedat (string), webhookfailoverurl (string), webhook_url (string), whatsapp` (object)
Create a Verify profile
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: verificationprofile), `sms` (object), `updatedat (string), webhookfailoverurl (string), webhook_url (string), whatsapp` (object)
Retrieve Verify profile message templates
List all Verify profile message templates.
GET /verify_profiles/templates
response = client.verify_profiles.retrieve_templates
puts(response)Returns: id (uuid), text (string)
Create message template
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 message template
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)
Retrieve Verify profile
Gets a single Verify profile.
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: verificationprofile), `sms` (object), `updatedat (string), webhookfailoverurl (string), webhook_url (string), whatsapp` (object)
Update Verify 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: verificationprofile), `sms` (object), `updatedat (string), webhookfailoverurl (string), webhook_url (string), whatsapp` (object)
Delete Verify profile
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: verificationprofile), `sms` (object), `updatedat (string), webhookfailoverurl (string), webhook_url (string), whatsapp` (object)
