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

Telnyx Numbers Config - 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 }.

Bulk update phone number profiles

POST /messagingnumbersbulkupdates — Required: messagingprofile_id, numbers

Optional: assign_only (boolean)

messaging_numbers_bulk_update = client.messaging_numbers_bulk_updates.create(
  messaging_profile_id: "00000000-0000-0000-0000-000000000000",
  numbers: ["+18880000000", "+18880000001", "+18880000002"]
)

puts(messaging_numbers_bulk_update)

Returns: failed (array[string]), orderid (uuid), pending (array[string]), recordtype (enum: messagingnumbersbulk_update), success (array[string])

Retrieve bulk update status

GET /messagingnumbersbulkupdates/{orderid}

messaging_numbers_bulk_update = client.messaging_numbers_bulk_updates.retrieve("order_id")

puts(messaging_numbers_bulk_update)

Returns: failed (array[string]), orderid (uuid), pending (array[string]), recordtype (enum: messagingnumbersbulk_update), success (array[string])

List mobile phone numbers with messaging settings

GET /mobilephonenumbers/messaging

page = client.mobile_phone_numbers.messaging.list

puts(page)

Returns: countrycode (string), createdat (date-time), features (object), id (string), messagingproduct (string), messagingprofileid (string | null), organizationid (string), phonenumber (string), recordtype (enum: messagingphonenumber, messagingsettings), tags (array[string]), traffictype (string), type (enum: longcode), updated_at (date-time)

Retrieve a mobile phone number with messaging settings

GET /mobilephonenumbers/{id}/messaging

messaging = client.mobile_phone_numbers.messaging.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(messaging)

Returns: countrycode (string), createdat (date-time), features (object), id (string), messagingproduct (string), messagingprofileid (string | null), organizationid (string), phonenumber (string), recordtype (enum: messagingphonenumber, messagingsettings), tags (array[string]), traffictype (string), type (enum: longcode), updated_at (date-time)

List phone numbers

GET /phone_numbers

page = client.phone_numbers.list

puts(page)

Returns: activatedat (object), billinggroupid (string | null), callforwardingenabled (boolean), callrecordingenabled (boolean), calleridnameenabled (boolean), cnamlistingenabled (boolean), connectionid (string | null), connectionname (string | null), countryisoalpha2 (string), createdat (date-time), customerreference (string | null), deletionlockenabled (boolean), emergencyaddressid (string | null), emergencyenabled (boolean), emergencystatus (enum: active, deprovisioning, disabled, provisioning, provisioning-failed), externalpin (string | null), hdvoiceenabled (boolean), id (string), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), messagingprofileid (string | null), messagingprofilename (string | null), phonenumber (string), phonenumbertype (enum: local, tollfree, mobile, national, sharedcost, landline, tollfree, shortcode, longcode), purchasedat (string), recordtype (string), sourcetype (object), status (enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending, requirement-info-pending, requirement-info-under-review, requirement-info-exception, provision-pending), t38faxgatewayenabled (boolean), tags (array[string]), updated_at (string)

Verify ownership of phone numbers

Verifies ownership of the provided phone numbers and returns a mapping of numbers to their IDs, plus a list of numbers not found in the account.

POST /phonenumbers/actions/verifyownership — Required: phone_numbers

response = client.phone_numbers.actions.verify_ownership(phone_numbers: ["+15551234567"])

puts(response)

Returns: found (array[object]), notfound (array[string]), recordtype (string)

Lists the phone numbers jobs

GET /phone_numbers/jobs

page = client.phone_numbers.jobs.list

puts(page)

Returns: createdat (string), etc (date-time), failedoperations (array[object]), id (uuid), pendingoperations (array[object]), phonenumbers (array[object]), recordtype (string), status (enum: pending, inprogress, completed, failed, expired), successfuloperations (array[object]), type (enum: updateemergencysettings, deletephonenumbers, updatephonenumbers), updatedat (string)

Delete a batch of numbers

Creates a new background job to delete a batch of numbers. At most one thousand numbers can be updated per API call.

POST /phonenumbers/jobs/deletephonenumbers — Required: phonenumbers

response = client.phone_numbers.jobs.delete_batch(phone_numbers: ["+19705555098", "+19715555098", "32873127836"])

puts(response)

Returns: createdat (string), etc (date-time), failedoperations (array[object]), id (uuid), pendingoperations (array[object]), phonenumbers (array[object]), recordtype (string), status (enum: pending, inprogress, completed, failed, expired), successfuloperations (array[object]), type (enum: updateemergencysettings, deletephonenumbers, updatephonenumbers), updatedat (string)

Update the emergency settings from a batch of numbers

Creates a background job to update the emergency settings of a collection of phone numbers. At most one thousand numbers can be updated per API call.

POST /phonenumbers/jobs/updateemergencysettings — Required: emergencyenabled, phone_numbers

Optional: emergencyaddressid (string | null)

response = client.phone_numbers.jobs.update_emergency_settings_batch(
  emergency_enabled: true,
  phone_numbers: ["+19705555098", "+19715555098", "32873127836"]
)

puts(response)

Returns: createdat (string), etc (date-time), failedoperations (array[object]), id (uuid), pendingoperations (array[object]), phonenumbers (array[object]), recordtype (string), status (enum: pending, inprogress, completed, failed, expired), successfuloperations (array[object]), type (enum: updateemergencysettings, deletephonenumbers, updatephonenumbers), updatedat (string)

Update a batch of numbers

Creates a new background job to update a batch of numbers. At most one thousand numbers can be updated per API call. At least one of the updateable fields must be submitted.

POST /phonenumbers/jobs/updatephonenumbers — Required: phonenumbers

Optional: billinggroupid (string), connectionid (string), customerreference (string), deletionlockenabled (boolean), externalpin (string), hdvoice_enabled (boolean), tags (array[string]), voice (object)

response = client.phone_numbers.jobs.update_batch(phone_numbers: ["1583466971586889004", "+13127367254"])

puts(response)

Returns: createdat (string), etc (date-time), failedoperations (array[object]), id (uuid), pendingoperations (array[object]), phonenumbers (array[object]), recordtype (string), status (enum: pending, inprogress, completed, failed, expired), successfuloperations (array[object]), type (enum: updateemergencysettings, deletephonenumbers, updatephonenumbers), updatedat (string)

Retrieve a phone numbers job

GET /phone_numbers/jobs/{id}

job = client.phone_numbers.jobs.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(job)

Returns: createdat (string), etc (date-time), failedoperations (array[object]), id (uuid), pendingoperations (array[object]), phonenumbers (array[object]), recordtype (string), status (enum: pending, inprogress, completed, failed, expired), successfuloperations (array[object]), type (enum: updateemergencysettings, deletephonenumbers, updatephonenumbers), updatedat (string)

List phone numbers with messaging settings

GET /phone_numbers/messaging

page = client.phone_numbers.messaging.list

puts(page)

Returns: countrycode (string), createdat (date-time), eligiblemessagingproducts (array[string]), features (object), health (object), id (string), messagingproduct (string), messagingprofileid (string | null), organizationid (string), phonenumber (string), recordtype (enum: messagingphonenumber, messagingsettings), tags (array[string]), traffictype (string), type (enum: long-code, toll-free, short-code, longcode, tollfree, shortcode), updated_at (date-time)

Slim List phone numbers

List phone numbers, This endpoint is a lighter version of the /phone_numbers endpoint having higher performance and rate limit.

GET /phone_numbers/slim

page = client.phone_numbers.slim_list

puts(page)

Returns: activatedat (object), billinggroupid (string), callforwardingenabled (boolean), callrecordingenabled (boolean), calleridnameenabled (boolean), cnamlistingenabled (boolean), connectionid (string), countryisoalpha2 (string), createdat (string), customerreference (string), emergencyaddressid (string), emergencyenabled (boolean), emergencystatus (enum: active, deprovisioning, disabled, provisioning, provisioning-failed), externalpin (string), hdvoiceenabled (boolean), id (string), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), phonenumber (string), phonenumbertype (enum: local, tollfree, mobile, national, sharedcost, landline, tollfree, shortcode, longcode), purchasedat (string), recordtype (string), status (enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending, requirement-info-pending, requirement-info-under-review, requirement-info-exception, provision-pending), t38faxgatewayenabled (boolean), updated_at (string)

List phone numbers with voice settings

GET /phone_numbers/voice

page = client.phone_numbers.voice.list

puts(page)

Returns: callforwarding (object), callrecording (object), cnamlisting (object), connectionid (string), customerreference (string), emergency (object), id (string), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), mediafeatures (object), phonenumber (string), recordtype (string), techprefixenabled (boolean), translatednumber (string), usagepayment_method (enum: pay-per-minute, channel)

Retrieve a phone number

GET /phone_numbers/{id}

phone_number = client.phone_numbers.retrieve("1293384261075731499")

puts(phone_number)

Returns: activatedat (object), billinggroupid (string | null), callforwardingenabled (boolean), callrecordingenabled (boolean), calleridnameenabled (boolean), cnamlistingenabled (boolean), connectionid (string | null), connectionname (string | null), countryisoalpha2 (string), createdat (date-time), customerreference (string | null), deletionlockenabled (boolean), emergencyaddressid (string | null), emergencyenabled (boolean), emergencystatus (enum: active, deprovisioning, disabled, provisioning, provisioning-failed), externalpin (string | null), hdvoiceenabled (boolean), id (string), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), messagingprofileid (string | null), messagingprofilename (string | null), phonenumber (string), phonenumbertype (enum: local, tollfree, mobile, national, sharedcost, landline, tollfree, shortcode, longcode), purchasedat (string), recordtype (string), sourcetype (object), status (enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending, requirement-info-pending, requirement-info-under-review, requirement-info-exception, provision-pending), t38faxgatewayenabled (boolean), tags (array[string]), updated_at (string)

Update a phone number

PATCH /phone_numbers/{id}

Optional: addressid (string), billinggroupid (string), connectionid (string), customerreference (string), externalpin (string), hdvoiceenabled (boolean), id (string), tags (array[string])

phone_number = client.phone_numbers.update("1293384261075731499")

puts(phone_number)

Returns: activatedat (object), billinggroupid (string | null), callforwardingenabled (boolean), callrecordingenabled (boolean), calleridnameenabled (boolean), cnamlistingenabled (boolean), connectionid (string | null), connectionname (string | null), countryisoalpha2 (string), createdat (date-time), customerreference (string | null), deletionlockenabled (boolean), emergencyaddressid (string | null), emergencyenabled (boolean), emergencystatus (enum: active, deprovisioning, disabled, provisioning, provisioning-failed), externalpin (string | null), hdvoiceenabled (boolean), id (string), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), messagingprofileid (string | null), messagingprofilename (string | null), phonenumber (string), phonenumbertype (enum: local, tollfree, mobile, national, sharedcost, landline, tollfree, shortcode, longcode), purchasedat (string), recordtype (string), sourcetype (object), status (enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending, requirement-info-pending, requirement-info-under-review, requirement-info-exception, provision-pending), t38faxgatewayenabled (boolean), tags (array[string]), updated_at (string)

Delete a phone number

DELETE /phone_numbers/{id}

phone_number = client.phone_numbers.delete("1293384261075731499")

puts(phone_number)

Returns: activatedat (object), billinggroupid (string), callforwardingenabled (boolean), callrecordingenabled (boolean), calleridnameenabled (boolean), cnamlistingenabled (boolean), connectionid (string), connectionname (string), createdat (string), customerreference (string), deletionlockenabled (boolean), emergencyaddressid (string), emergencyenabled (boolean), externalpin (string), hdvoiceenabled (boolean), id (string), messagingprofileid (string), messagingprofilename (string), phonenumber (string), phonenumbertype (enum: local, tollfree, mobile, national, sharedcost, landline), purchasedat (string), recordtype (string), status (enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending), t38faxgatewayenabled (boolean), tags (array[string]), updated_at (string)

Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)

PATCH /phonenumbers/{id}/actions/bundlestatuschange — Required: bundleid

response = client.phone_numbers.actions.change_bundle_status(
  "1293384261075731499",
  bundle_id: "5194d8fc-87e6-4188-baa9-1c434bbe861b"
)

puts(response)

Returns: callforwarding (object), callrecording (object), cnamlisting (object), connectionid (string), customerreference (string), emergency (object), id (string), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), mediafeatures (object), phonenumber (string), recordtype (string), techprefixenabled (boolean), translatednumber (string), usagepayment_method (enum: pay-per-minute, channel)

Enable emergency for a phone number

POST /phonenumbers/{id}/actions/enableemergency — Required: emergencyenabled, emergencyaddress_id

response = client.phone_numbers.actions.enable_emergency(
  "1293384261075731499",
  emergency_address_id: "53829456729313",
  emergency_enabled: true
)

puts(response)

Returns: callforwarding (object), callrecording (object), cnamlisting (object), connectionid (string), customerreference (string), emergency (object), id (string), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), mediafeatures (object), phonenumber (string), recordtype (string), techprefixenabled (boolean), translatednumber (string), usagepayment_method (enum: pay-per-minute, channel)

Retrieve a phone number with messaging settings

GET /phone_numbers/{id}/messaging

messaging = client.phone_numbers.messaging.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(messaging)

Returns: countrycode (string), createdat (date-time), eligiblemessagingproducts (array[string]), features (object), health (object), id (string), messagingproduct (string), messagingprofileid (string | null), organizationid (string), phonenumber (string), recordtype (enum: messagingphonenumber, messagingsettings), tags (array[string]), traffictype (string), type (enum: long-code, toll-free, short-code, longcode, tollfree, shortcode), updated_at (date-time)

Update the messaging profile and/or messaging product of a phone number

PATCH /phone_numbers/{id}/messaging

Optional: messagingproduct (string), messagingprofile_id (string), tags (array[string])

messaging = client.phone_numbers.messaging.update("550e8400-e29b-41d4-a716-446655440000")

puts(messaging)

Returns: countrycode (string), createdat (date-time), eligiblemessagingproducts (array[string]), features (object), health (object), id (string), messagingproduct (string), messagingprofileid (string | null), organizationid (string), phonenumber (string), recordtype (enum: messagingphonenumber, messagingsettings), tags (array[string]), traffictype (string), type (enum: long-code, toll-free, short-code, longcode, tollfree, shortcode), updated_at (date-time)

Retrieve a phone number with voice settings

GET /phone_numbers/{id}/voice

voice = client.phone_numbers.voice.retrieve("1293384261075731499")

puts(voice)

Returns: callforwarding (object), callrecording (object), cnamlisting (object), connectionid (string), customerreference (string), emergency (object), id (string), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), mediafeatures (object), phonenumber (string), recordtype (string), techprefixenabled (boolean), translatednumber (string), usagepayment_method (enum: pay-per-minute, channel)

Update a phone number with voice settings

PATCH /phone_numbers/{id}/voice

Optional: callforwarding (object), callrecording (object), calleridnameenabled (boolean), cnamlisting (object), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), mediafeatures (object), techprefixenabled (boolean), translatednumber (string), usagepaymentmethod (enum: pay-per-minute, channel)

voice = client.phone_numbers.voice.update("1293384261075731499")

puts(voice)

Returns: callforwarding (object), callrecording (object), cnamlisting (object), connectionid (string), customerreference (string), emergency (object), id (string), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), mediafeatures (object), phonenumber (string), recordtype (string), techprefixenabled (boolean), translatednumber (string), usagepayment_method (enum: pay-per-minute, channel)

List Mobile Phone Numbers

GET /v2/mobilephonenumbers

page = client.mobile_phone_numbers.list

puts(page)

Returns: callforwarding (object), callrecording (object), calleridnameenabled (boolean), cnamlisting (object), connectionid (string | null), connectionname (string | null), connectiontype (string | null), countryisoalpha2 (string), createdat (date-time), customerreference (string | null), id (string), inbound (object), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), mobilevoiceenabled (boolean), noisesuppression (enum: inbound, outbound, both, disabled), outbound (object), phonenumber (string), recordtype (string), simcardid (uuid), status (string), tags (array[string]), updated_at (date-time)

Retrieve a Mobile Phone Number

GET /v2/mobilephonenumbers/{id}

mobile_phone_number = client.mobile_phone_numbers.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(mobile_phone_number)

Returns: callforwarding (object), callrecording (object), calleridnameenabled (boolean), cnamlisting (object), connectionid (string | null), connectionname (string | null), connectiontype (string | null), countryisoalpha2 (string), createdat (date-time), customerreference (string | null), id (string), inbound (object), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), mobilevoiceenabled (boolean), noisesuppression (enum: inbound, outbound, both, disabled), outbound (object), phonenumber (string), recordtype (string), simcardid (uuid), status (string), tags (array[string]), updated_at (date-time)

Update a Mobile Phone Number

PATCH /v2/mobilephonenumbers/{id}

Optional: callforwarding (object), callrecording (object), calleridnameenabled (boolean), cnamlisting (object), connectionid (string | null), customerreference (string | null), inbound (object), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), noise_suppression (boolean), outbound (object), tags (array[string])

mobile_phone_number = client.mobile_phone_numbers.update("550e8400-e29b-41d4-a716-446655440000")

puts(mobile_phone_number)

Returns: callforwarding (object), callrecording (object), calleridnameenabled (boolean), cnamlisting (object), connectionid (string | null), connectionname (string | null), connectiontype (string | null), countryisoalpha2 (string), createdat (date-time), customerreference (string | null), id (string), inbound (object), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), mobilevoiceenabled (boolean), noisesuppression (enum: inbound, outbound, both, disabled), outbound (object), phonenumber (string), recordtype (string), simcardid (uuid), status (string), tags (array[string]), updated_at (date-time)