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

Telnyx Numbers - 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:

available_phone_numbers = client.available_phone_numbers.list
puts(available_phone_numbers)

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

Reference Use Rules

Do not invent Telnyx parameters, enums, response fields, or webhook fields.

• If the parameter, enum, or response field you need is not shown inline in this skill, read [references/api-details.md](references/api-details.md) before writing code.
• Before using any operation in ## Additional Operations, read [the optional-parameters section](references/api-details.md#optional-parameters) and [the response-schemas section](references/api-details.md#response-schemas).

Core Tasks

Search available phone numbers

Number search is the entrypoint for provisioning. Agents need the search method, key query filters, and the fields returned for candidate numbers.

client.availablephonenumbers.list() — GET /availablephonenumbers

available_phone_numbers = client.available_phone_numbers.list

puts(available_phone_numbers)

Response wrapper:

• items: availablephonenumbers.data
• pagination: availablephonenumbers.meta

Primary item fields:

• phone_number
• record_type
• quickship
• reservable
• best_effort
• cost_information

Create a number order

Number ordering is the production provisioning step after number selection.

client.numberorders.create() — POST /numberorders

number_order = client.number_orders.create(phone_numbers: [{"phone_number": "+18005550101"}])
puts(number_order)

Primary response fields:

• number_order.data.id
• number_order.data.status
• numberorder.data.phonenumbers_count
• numberorder.data.requirementsmet
• numberorder.data.messagingprofile_id
• numberorder.data.connectionid

Check number order status

Order status determines whether provisioning completed or additional requirements are still blocking fulfillment.

client.numberorders.retrieve() — GET /numberorders/{numberorderid}

number_order = client.number_orders.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(number_order)

Primary response fields:

• number_order.data.id
• number_order.data.status
• numberorder.data.requirementsmet
• numberorder.data.phonenumbers_count
• numberorder.data.phonenumbers
• numberorder.data.connectionid

Important Supporting Operations

Use these when the core tasks above are close to your flow, but you need a common variation or follow-up step.

Create a number reservation

Create or provision an additional resource when the core tasks do not cover this flow.

client.numberreservations.create() — POST /numberreservations

number_reservation = client.number_reservations.create(phone_numbers: [{"phone_number": "+18005550101"}])
puts(number_reservation)

Primary response fields:

• number_reservation.data.id
• number_reservation.data.status
• numberreservation.data.createdat
• numberreservation.data.updatedat
• numberreservation.data.customerreference
• number_reservation.data.errors

Retrieve a number reservation

Fetch the current state before updating, deleting, or making control-flow decisions.

client.numberreservations.retrieve() — GET /numberreservations/{numberreservationid}

number_reservation = client.number_reservations.retrieve("550e8400-e29b-41d4-a716-446655440000")

puts(number_reservation)

Primary response fields:

• number_reservation.data.id
• number_reservation.data.status
• numberreservation.data.createdat
• numberreservation.data.updatedat
• numberreservation.data.customerreference
• number_reservation.data.errors

List Advanced Orders

Inspect available resources or choose an existing resource before mutating it.

client.advancedorders.list() — GET /advancedorders

advanced_orders = client.advanced_orders.list

puts(advanced_orders)

Response wrapper:

• items: advanced_orders.data

Primary item fields:

• id
• status
• area_code
• comments
• country_code
• customer_reference

Create Advanced Order

Create or provision an additional resource when the core tasks do not cover this flow.

client.advancedorders.create() — POST /advancedorders

advanced_order = client.advanced_orders.create

puts(advanced_order)

Primary response fields:

• advanced_order.id
• advanced_order.status
• advancedorder.areacode
• advanced_order.comments
• advancedorder.countrycode
• advancedorder.customerreference

Update Advanced Order

Modify an existing resource without recreating it.

client.advancedorders.updaterequirementgroup() — PATCH /advancedorders/{advanced-order-id}/requirement_group

response = client.advanced_orders.update_requirement_group("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(response)

Primary response fields:

• response.id
• response.status
• response.area_code
• response.comments
• response.country_code
• response.customer_reference

Get Advanced Order

Fetch the current state before updating, deleting, or making control-flow decisions.

client.advancedorders.retrieve() — GET /advancedorders/{order_id}

advanced_order = client.advanced_orders.retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

puts(advanced_order)

Primary response fields:

• advanced_order.id
• advanced_order.status
• advancedorder.areacode
• advanced_order.comments
• advancedorder.countrycode
• advancedorder.customerreference

List available phone number blocks

Inspect available resources or choose an existing resource before mutating it.

client.availablephonenumberblocks.list() — GET /availablephonenumberblocks

available_phone_number_blocks = client.available_phone_number_blocks.list

puts(available_phone_number_blocks)

Response wrapper:

• items: availablephonenumber_blocks.data
• pagination: availablephonenumber_blocks.meta

Primary item fields:

• phone_number
• cost_information
• features
• range
• record_type
• region_information

Retrieve all comments

Inspect available resources or choose an existing resource before mutating it.

client.comments.list() — GET /comments

comments = client.comments.list

puts(comments)

Response wrapper:

• items: comments.data
• pagination: comments.meta

Primary item fields:

• id
• body
• created_at
• updated_at
• commentrecordid
• commentrecordtype

Additional Operations

Use the core tasks above first. The operations below are indexed here with exact SDK methods and required params; use [references/api-details.md](references/api-details.md) for full optional params, response schemas, and lower-frequency webhook payloads. Before using any operation below, read [the optional-parameters section](references/api-details.md#optional-parameters) and [the response-schemas section](references/api-details.md#response-schemas) so you do not guess missing fields.

Other Webhook Events

For exhaustive optional parameters, full response schemas, and complete webhook payloads, see [references/api-details.md](references/api-details.md).