Skip to main content

List phone numbers with voice settings

GET 
/phone_numbers/voice

List phone numbers with voice settings

Request ​

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

    filter[phone_number] string

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

    filter[connection_name][contains] string

    Filter contains connection name. Requires at least three characters.

    filter[customer_reference] string

    Filter numbers via the customer_reference set.

    filter[voice.usage_payment_method] string

    Possible values: [pay-per-minute, channel]

    Filter by usage_payment_method.

    sort string

    Possible values: [purchased_at, phone_number, connection_name, usage_payment_method]

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

Responses ​

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

Schema

    data

    object[]

  • Array [

    • id string

    Identifies the type of resource.

    record_type string

    Identifies the type of the resource.

    phone_number string

    The phone number in +E164 format.

    connection_id string

    Identifies the connection associated with this phone number.

    customer_reference string

    A customer reference string for customer look ups.

    tech_prefix_enabled boolean

    Controls whether a tech prefix is enabled for this phone number.

    translated_number string

    This field allows you to rewrite the destination number of an inbound call before the call is routed to you. The value of this field may be any alphanumeric value, and the value will replace the number originally dialed.

    call_forwarding

    object

    The call forwarding settings for a phone number.

    call_forwarding_enabled boolean

    Default value: true

    Indicates if call forwarding will be enabled for this number if forwards_to and forwarding_type are filled in. Defaults to true for backwards compatibility with APIV1 use of numbers endpoints.

    forwards_to string

    The phone number to which inbound calls to this number are forwarded. Inbound calls will not be forwarded if this field is left blank. If set, must be a +E.164-formatted phone number.

    forwarding_type string

    Possible values: [always, on_failure]

    Call forwarding type. 'forwards_to' must be set for this to have an effect.

    The call forwarding settings for a phone number.

    cnam_listing

    object

    The CNAM listing settings for a phone number.

    cnam_listing_enabled boolean

    Enables CNAM listings for this number. Requires cnam_listing_details to also be set.

    cnam_listing_details string

    The CNAM listing details for this number. Must be alphanumeric characters or spaces with a maximum length of 15. Requires cnam_listing_enabled to also be set to true.

    The CNAM listing settings for a phone number.

    emergency

    object

    The emergency services settings for a phone number.

    emergency_enabled boolean

    Allows you to enable or disable emergency services on the phone number. In order to enable emergency services, you must also set an emergency_address_id.

    emergency_address_id int64

    Identifies the address to be used with emergency services.

    emergency_status string

    Possible values: [disabled, active, provisioning, deprovisioning]

    Default value: disabled

    Represents the state of the number regarding emergency activation.

    The emergency services settings for a phone number.

    usage_payment_method string

    Possible values: [pay-per-minute, channel]

    Default value: pay-per-minute

    Controls whether a number is billed per minute or uses your concurrent channels.

    media_features

    object

    The media features settings for a phone number.

    rtp_auto_adjust_enabled boolean

    Default value: true

    When RTP Auto-Adjust is enabled, the destination RTP address port will be automatically changed to match the source of the incoming RTP packets.

    accept_any_rtp_packets_enabled boolean

    When enabled, Telnyx will accept RTP packets from any customer-side IP address and port, not just those to which Telnyx is sending RTP.

    t38_fax_gateway_enabled boolean

    Controls whether Telnyx will accept a T.38 re-INVITE for this phone number. Note that Telnyx will not send a T.38 re-INVITE; this option only controls whether one will be accepted.

    The media features settings for a phone number.

    call_recording

    object

    The call recording settings for a phone number.

    inbound_call_recording_enabled boolean

    When enabled, any inbound call to this number will be recorded.

    inbound_call_recording_format string

    Possible values: [wav, mp3]

    Default value: wav

    The audio file format for calls being recorded.

    inbound_call_recording_channels string

    Possible values: [single, dual]

    Default value: single

    When using 'dual' channels, final audio file will be stereo recorded with the first leg on channel A, and the rest on channel B.

    The call recording settings for a phone number.

    inbound_call_screening string

    Possible values: [disabled, reject_calls, flag_calls]

    Default value: disabled

    The inbound_call_screening setting is a phone number configuration option variable that allows users to configure their settings to block or flag fraudulent calls. It can be set to disabled, reject_calls, or flag_calls. This feature has an additional per-number monthly cost associated with it.

  • ]

    • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta

    object

    url string

    URL with additional information on the error.

  • ]

Request samples

curl -L 'https://api.telnyx.com/v2/phone_numbers/voice' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "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"
      },
      "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
  }
}