Skip to main content
GET
/
external_connections
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 externalConnection of client.externalConnections.list()) {
  console.log(externalConnection.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.list()
page = page.data[0]
print(page.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.List(context.TODO(), telnyx.ExternalConnectionListParams{})
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.ExternalConnectionListPage;
import com.telnyx.sdk.models.externalconnections.ExternalConnectionListParams;

public final class Main {
private Main() {}

public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();

ExternalConnectionListPage page = client.externalConnections().list();
}
}
require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

page = telnyx.external_connections.list

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->list(
filter: [
'id' => '1930241863466354012',
'connectionName' => ['contains' => 'My Connection'],
'createdAt' => '2022-12-31',
'externalSipConnection' => 'zoom',
'phoneNumber' => ['contains' => '+15555555555'],
],
pageNumber: 0,
pageSize: 0,
);

var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}
telnyx external-connections list \
--api-key 'My API Key'
curl --request GET \
--url https://api.telnyx.com/v2/external_connections \
--header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "1930241863466354012",
      "record_type": "external_connection",
      "external_sip_connection": "zoom",
      "credential_active": false,
      "active": false,
      "created_at": "2022-06-29T19:23:59Z",
      "updated_at": "2022-06-29T19:39:47Z",
      "outbound": {
        "outbound_voice_profile_id": "1911630617284445511"
      }
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter
object

Filter parameter for external connections (deepObject style). Supports filtering by connection_name, external_sip_connection, id, created_at, and phone_number.

page
object

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

Response

Successful response

data
External Connection · object[]
meta
Pagination Meta · object