List all phone numbers
Returns a list of all active phone numbers associated with the given external connection.
GET
/
external_connections
/
{id}
/
phone_numbers
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const externalConnectionPhoneNumber of client.externalConnections.phoneNumbers.list(
'1293384261075731499',
)) {
console.log(externalConnectionPhoneNumber.civic_address_id);
}import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
page = client.external_connections.phone_numbers.list(
id="1293384261075731499",
)
page = page.data[0]
print(page.civic_address_id)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
page, err := client.ExternalConnections.PhoneNumbers.List(
context.TODO(),
"1293384261075731499",
telnyx.ExternalConnectionPhoneNumberListParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.externalconnections.phonenumbers.PhoneNumberListPage;
import com.telnyx.sdk.models.externalconnections.phonenumbers.PhoneNumberListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
PhoneNumberListPage page = client.externalConnections().phoneNumbers().list("1293384261075731499");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
page = telnyx.external_connections.phone_numbers.list("1293384261075731499")
puts(page)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$page = $client->externalConnections->phoneNumbers->list(
'1293384261075731499',
filter: [
'civicAddressID' => ['eq' => '19990261512338516954'],
'locationID' => ['eq' => '19995665508264022121'],
'phoneNumber' => ['contains' => '+1970', 'eq' => '+19705555098'],
],
pageNumber: 0,
pageSize: 0,
);
var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx external-connections:phone-numbers list \
--api-key 'My API Key' \
--id 1293384261075731499curl --request GET \
--url https://api.telnyx.com/v2/external_connections/{id}/phone_numbers \
--header 'Authorization: Bearer <token>'{
"data": [
{
"ticket_id": "542c3bca-d247-42bc-8fe7-e01d16ecd761",
"telephone_number": "<string>",
"number_id": "<string>",
"civic_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"displayed_country_code": "<string>",
"acquired_capabilities": []
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Identifies the resource.
Example:
"1293384261075731499"
Query Parameters
Filter parameter for phone numbers (deepObject style). Supports filtering by phone_number, civic_address_id, and location_id with eq/contains operations.
Show child attributes
Show child attributes
Consolidated page parameter (deepObject style). Originally: page[size], page[number]
Show child attributes
Show child attributes
Was this page helpful?
⌘I
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const externalConnectionPhoneNumber of client.externalConnections.phoneNumbers.list(
'1293384261075731499',
)) {
console.log(externalConnectionPhoneNumber.civic_address_id);
}import os
from telnyx import Telnyx
client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
page = client.external_connections.phone_numbers.list(
id="1293384261075731499",
)
page = page.data[0]
print(page.civic_address_id)package main
import (
"context"
"fmt"
"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)
func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
page, err := client.ExternalConnections.PhoneNumbers.List(
context.TODO(),
"1293384261075731499",
telnyx.ExternalConnectionPhoneNumberListParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.externalconnections.phonenumbers.PhoneNumberListPage;
import com.telnyx.sdk.models.externalconnections.phonenumbers.PhoneNumberListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
PhoneNumberListPage page = client.externalConnections().phoneNumbers().list("1293384261075731499");
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
page = telnyx.external_connections.phone_numbers.list("1293384261075731499")
puts(page)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');
try {
$page = $client->externalConnections->phoneNumbers->list(
'1293384261075731499',
filter: [
'civicAddressID' => ['eq' => '19990261512338516954'],
'locationID' => ['eq' => '19995665508264022121'],
'phoneNumber' => ['contains' => '+1970', 'eq' => '+19705555098'],
],
pageNumber: 0,
pageSize: 0,
);
var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx external-connections:phone-numbers list \
--api-key 'My API Key' \
--id 1293384261075731499curl --request GET \
--url https://api.telnyx.com/v2/external_connections/{id}/phone_numbers \
--header 'Authorization: Bearer <token>'{
"data": [
{
"ticket_id": "542c3bca-d247-42bc-8fe7-e01d16ecd761",
"telephone_number": "<string>",
"number_id": "<string>",
"civic_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"displayed_country_code": "<string>",
"acquired_capabilities": []
}
],
"meta": {
"total_pages": 3,
"total_results": 55,
"page_number": 2,
"page_size": 25
}
}