Telnyx_Test

List all phone numbers

GET

/external_connections/{id}/phone_numbers

External Connections

Returns a list of all active phone numbers associated with the given external connection.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/external_connections//phone_numbers'

Response Example

{
    "data": [
        {
            "acquired_capabilities": [
                "FirstPartyAppAssignment"
            ],
            "civic_address_id": "9e5bc035-bfd1-4509-a9fc-0341e88b9762",
            "displayed_country_code": "string",
            "location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795",
            "number_id": "string",
            "telephone_number": "string",
            "ticket_id": "542c3bca-d247-42bc-8fe7-e01d16ecd761"
        }
    ],
    "meta": {
        "page_number": 2,
        "page_size": 25,
        "total_pages": 3,
        "total_results": 55
    }
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string <int64>

required

Identifies the resource.

Example:

1293384261075731499

Query Params

page[number]

integer

optional

The page number to load

>= 1

Default:

page[size]

integer

optional

The size of the page

>= 1<= 250

Default:

filter[phone_number][eq]

string <E164>

optional

The phone number to filter by

Example:

+1234567890

filter[phone_number][contains]

string

optional

The partial phone number to filter by. Requires 3-15 digits.

Example:

+123

filter[civic_address_id][eq]

string <uuid>

optional

The civic address ID to filter by

Example:

67ea7693-9cd5-4a68-8c76-abb3aa5bf5d2

filter[location_id][eq]

string <uuid>

optional

The location ID to filter by

Example:

52545f6f-9cd5-4a68-8c76-abb3aa5bf5d2

Responses

🟢200OK

application/json

Successful response

Body

data

array[object (Phone number details with relation to an external connection) {7}]

optional

acquired_capabilities

array[string]

optional

Allowed values:

FirstPartyAppAssignmentInboundCallingOffice365OutboundCallingUserAssignment

civic_address_id

string <uuid>

optional

Identifies the civic address assigned to the phone number.

displayed_country_code

string

optional

The iso country code that will be displayed to the user when they receive a call from this phone number.

location_id

string <uuid>

optional

Identifies the location assigned to the phone number.

number_id

string

optional

Phone number ID from the Telnyx API.

telephone_number

string

optional

Phone number in E164 format.

ticket_id

string <uuid>

optional

Uniquely identifies the resource.

Example:

542c3bca-d247-42bc-8fe7-e01d16ecd761