Sign in
OpenAPI 3.1.0raw.githubusercontent.com2026-08-171,3412,1384.9 MB

1571b0380bd7

Phone Number Configurations

List phone numbers with voice settings

Returns account phone numbers together with their voice settings. Results support pagination, sorting, and filters for number, connection name, customer reference, and voice usage payment method.

get/phone_numbers/voice

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

sort'purchased_at' | 'phone_number' | 'connection_name' | 'usage_payment_method'
Example:connection_name

Specifies the sort order for results. If not given, results are sorted by created_at in descending order.

customer_referencestring

Filter numbers via the customer_reference set.

phone_numberstring

Filter by phone number. Requires at least three digits. Non-numerical characters will result in no values being returned.

voice.usage_payment_method'pay-per-minute' | 'channel'

Filter by usage_payment_method.

Consolidated filter parameter (deepObject style). Originally: filter[phone_number], filter[connection_name], filter[customer_reference], filter[voice.usage_payment_method]

{
  "connection_name": {
    "contains": "test"
  },
  "voice.usage_payment_method": "channel"
}

Response

Successful response with a list of phone numbers with voice settings.

Example response

{
  "data": [
    {
      "call_forwarding": {
        "call_forwarding_enabled": true,
        "forwarding_type": "always",
        "forwards_to": "+13035559123"
      },
      "call_recording": {
        "inbound_call_recording_channels": "single",
        "inbound_call_recording_enabled": true,
        "inbound_call_recording_format": "wav"
      },
      "cnam_listing": {
        "cnam_listing_details": "example",
        "cnam_listing_enabled": true
      },
      "connection_id": "1d0e6cb8-8668-462e-94c6-49ae0f0ed48b",
      "customer_reference": "customer-reference",
      "emergency": {
        "emergency_address_id": "1315261609962112019",
        "emergency_enabled": true,
        "emergency_status": "active"
      },
      "id": "1293384261075731499",
      "inbound_call_screening": "disabled",
      "media_features": {
        "accept_any_rtp_packets_enabled": true,
        "rtp_auto_adjust_enabled": true,
        "t38_fax_gateway_enabled": true
      },
      "record_type": "voice_settings",
      "tech_prefix_enabled": false,
      "translated_number": "+13035559999",
      "usage_payment_method": "pay-per-minute"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}