/telnyx-numbers-ruby

name: telnyx-numbers-ruby
description: >-
  Search, order, and manage phone numbers by location, features, and coverage.
metadata:
  author: telnyx
  product: numbers
  language: ruby
  generated_by: telnyx-openapi-pipeline
  contract: v2

<!-- 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
  public_key: ENV["TELNYX_PUBLIC_KEY"], # Required for client.webhooks.unwrap (webhook verification)
)

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
  available_phone_numbers = client.available_phone_numbers.list
  puts(available_phone_numbers)
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).

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_each` for automatic iteration: `page.auto_paging_each { |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.available_phone_numbers.list()` — `GET /available_phone_numbers`

| Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | object | No | Consolidated filter parameter (deepObject style). |

available_phone_numbers = client.available_phone_numbers.list

puts(available_phone_numbers)

Response wrapper:

• items: `available_phone_numbers.data`
• pagination: `available_phone_numbers.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.number_orders.create()` — `POST /number_orders`

| Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `phone_numbers` | array[object] | Yes | | | `connection_id` | string (UUID) | No | Identifies the connection associated with this phone number. | | `messaging_profile_id` | string (UUID) | No | Identifies the messaging profile associated with the phone n... | | `billing_group_id` | string (UUID) | No | Identifies the billing group associated with the phone numbe... | | ... | | | +1 optional params in [references/api-details.md](references/api-details.md) |

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`
• `number_order.data.phone_numbers_count`
• `number_order.data.requirements_met`
• `number_order.data.messaging_profile_id`
• `number_order.data.connection_id`

Check number order status

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

`client.number_orders.retrieve()` — `GET /number_orders/{number_order_id}`

| Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `number_order_id` | string (UUID) | Yes | The number order ID. |

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`
• `number_order.data.requirements_met`
• `number_order.data.phone_numbers_count`
• `number_order.data.phone_numbers`
• `number_order.data.connection_id`

---

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.number_reservations.create()` — `POST /number_reservations`

| Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `phone_numbers` | array[object] | Yes | | | `status` | enum (pending, success, failure) | No | The status of the entire reservation. | | `id` | string (UUID) | No | | | `record_type` | string | No | | | ... | | | +3 optional params in [references/api-details.md](references/api-details.md) |

number_reservation = client.number_reservations.create(phone_