Phone Number Configurations

List phone numbers with voice settings

Changed on

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

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/phone_numbers/voice
  • Auth: HTTP bearer

Query parameters

sizeinteger

The size of the page

numberinteger

The page number to load

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.

phone_numberstring

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

customer_referencestring

Filter numbers via the customer_reference set.

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

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status