<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Verify - Ruby

Installation

gem install telnyx

Setup

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
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).

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 .autopagingeach for automatic iteration: page.autopagingeach { |item| puts item.id }.

Lookup phone number data

Returns information about the provided phone number.

GET /numberlookup/{phonenumber}

number_lookup = client.number_lookup.retrieve("+18665552368")

puts(number_lookup)

Returns: callername (object), carrier (object), countrycode (string), fraud (string | null), nationalformat (string), phonenumber (string), portability (object), record_type (string)

List verifications by phone number

GET /verifications/byphonenumber/{phone_number}

by_phone_numbers = client.verifications.by_phone_number.list("+13035551234")

puts(by_phone_numbers)

Returns: createdat (string), customcode (string | null), id (uuid), phonenumber (string), recordtype (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeoutsecs (integer), type (enum: sms, call, flashcall, whatsapp), updatedat (string), verifyprofileid (uuid)

Verify verification code by phone number

POST /verifications/byphonenumber/{phonenumber}/actions/verify — Required: code, verifyprofile_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: phonenumber (string), responsecode (enum: accepted, rejected)

Trigger Call verification

POST /verifications/call — Required: phonenumber, verifyprofile_id

Optional: customcode (string | null), extension (string | null), timeoutsecs (integer)

create_verification_response = client.verifications.trigger_call(
  phone_number: "+13035551234",
  verify_profile_id: "12ade33a-21c0-473b-b055-b3c836e1c292"
)

puts(create_verification_response)

Returns: createdat (string), customcode (string | null), id (uuid), phonenumber (string), recordtype (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeoutsecs (integer), type (enum: sms, call, flashcall, whatsapp), updatedat (string), verifyprofileid (uuid)

Trigger Flash call verification

POST /verifications/flashcall — Required: phonenumber, verifyprofile_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: createdat (string), customcode (string | null), id (uuid), phonenumber (string), recordtype (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeoutsecs (integer), type (enum: sms, call, flashcall, whatsapp), updatedat (string), verifyprofileid (uuid)

Trigger SMS verification

POST /verifications/sms — Required: phonenumber, verifyprofile_id

Optional: customcode (string | null), timeoutsecs (integer)

create_verification_response = client.verifications.trigger_sms(
  phone_number: "+13035551234",
  verify_profile_id: "12ade33a-21c0-473b-b055-b3c836e1c292"
)

puts(create_verification_response)

Returns: createdat (string), customcode (string | null), id (uuid), phonenumber (string), recordtype (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeoutsecs (integer), type (enum: sms, call, flashcall, whatsapp), updatedat (string), verifyprofileid (uuid)

Trigger WhatsApp verification

POST /verifications/whatsapp — Required: phonenumber, verifyprofile_id

Optional: customcode (string | null), timeoutsecs (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: createdat (string), customcode (string | null), id (uuid), phonenumber (string), recordtype (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeoutsecs (integer), type (enum: sms, call, flashcall, whatsapp), updatedat (string), verifyprofileid (uuid)

Retrieve verification

GET /verifications/{verification_id}

verification = client.verifications.retrieve("12ade33a-21c0-473b-b055-b3c836e1c292")

puts(verification)

Returns: createdat (string), customcode (string | null), id (uuid), phonenumber (string), recordtype (enum: verification), status (enum: pending, accepted, invalid, expired, error), timeoutsecs (integer), type (enum: sms, call, flashcall, whatsapp), updatedat (string), verifyprofileid (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: phonenumber (string), responsecode (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), createdat (string), dailyspendlimit (number), dailyspendlimitenabled (boolean), flashcall (object), id (uuid), language (string), name (string), recordtype (enum: verificationprofile), sms (object), updatedat (string), webhookfailoverurl (string), webhookurl (string), whatsapp (object)

Create a Verify profile

Creates a new Verify profile to associate verifications with.

POST /verify_profiles — Required: name

Optional: call (object), dailyspendlimit (number), dailyspendlimitenabled (boolean), flashcall (object), language (string), sms (object), webhookfailoverurl (string), webhookurl (string), whatsapp (object)

verify_profile_data = client.verify_profiles.create(name: "Test Profile")

puts(verify_profile_data)

Returns: call (object), createdat (string), dailyspendlimit (number), dailyspendlimitenabled (boolean), flashcall (object), id (uuid), language (string), name (string), recordtype (enum: verificationprofile), sms (object), updatedat (string), webhookfailoverurl (string), webhookurl (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 /verifyprofiles/templates/{templateid} — 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 /verifyprofiles/{verifyprofile_id}

verify_profile_data = client.verify_profiles.retrieve("12ade33a-21c0-473b-b055-b3c836e1c292")

puts(verify_profile_data)

Returns: call (object), createdat (string), dailyspendlimit (number), dailyspendlimitenabled (boolean), flashcall (object), id (uuid), language (string), name (string), recordtype (enum: verificationprofile), sms (object), updatedat (string), webhookfailoverurl (string), webhookurl (string), whatsapp (object)

Update Verify profile

PATCH /verifyprofiles/{verifyprofile_id}

Optional: call (object), dailyspendlimit (number), dailyspendlimitenabled (boolean), language (string), name (string), sms (object), webhookfailoverurl (string), webhookurl (string), whatsapp (object)

verify_profile_data = client.verify_profiles.update("12ade33a-21c0-473b-b055-b3c836e1c292")

puts(verify_profile_data)

Returns: call (object), createdat (string), dailyspendlimit (number), dailyspendlimitenabled (boolean), flashcall (object), id (uuid), language (string), name (string), recordtype (enum: verificationprofile), sms (object), updatedat (string), webhookfailoverurl (string), webhookurl (string), whatsapp (object)

Delete Verify profile

DELETE /verifyprofiles/{verifyprofile_id}

verify_profile_data = client.verify_profiles.delete("12ade33a-21c0-473b-b055-b3c836e1c292")

puts(verify_profile_data)

Returns: call (object), createdat (string), dailyspendlimit (number), dailyspendlimitenabled (boolean), flashcall (object), id (uuid), language (string), name (string), recordtype (enum: verificationprofile), sms (object), updatedat (string), webhookfailoverurl (string), webhookurl (string), whatsapp (object)