Telnyx

import Telnyx from 'telnyx'; const client = new Telnyx({ apiKey: 'My API Key', }); const externalConnection = await client.externalConnections.update('id', { outbound: { outbound_voice_profile_id: 'outbound_voice_profile_id' }, }); console.log(externalConnection.data);

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

Authorizations

Authorization

string

header

required

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

Path Parameters

string<int64>

required

Identifies the resource.

Example:

"1293384261075731499"

Body

application/json

Parameters to be updated for the External Connection

outbound

object

required

Show child attributes

outbound.outbound_voice_profile_id

string<int64>

required

Identifies the associated outbound voice profile.

Example:

"1293384261075731499"

outbound.channel_limit

integer

When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.

Example:

10

active

boolean

default:true

Specifies whether the connection can be used.

Example:

false

webhook_event_url

string<uri>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

Example:

"https://example.com"

webhook_event_failover_url

string<uri> | null

default:""

The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.

Example:

"https://failover.example.com"

Response

Successful response

data

External Connection · object

Show child attributes

data.id

string<int64>

Uniquely identifies the resource.

Example:

"1293384261075731499"

data.record_type

string

Identifies the type of the resource.

Example:

"external_connection"

data.active

boolean

default:true

Specifies whether the connection can be used.

Example:

false

data.credential_active

boolean

default:false

If the credential associated with this service is active.

Example:

true

data.external_sip_connection

enum<string>

default:zoom

The service that will be consuming this connection.

Available options:

zoom,

operator_connect

Example:

"zoom"

data.tags

string[]

Tags associated with the connection.

Example:

["tag1", "tag2"]

data.webhook_event_url

string<uri>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

Example:

"https://example.com"

data.webhook_event_failover_url

string<uri> | null

default:""

The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.

Example:

"https://failover.example.com"

data.webhook_api_version

enum<string>

default:1

Determines which webhook format will be used, Telnyx API v1 or v2.

Available options:

1,

2

Example:

"1"

data.webhook_timeout_secs

integer | null

Specifies how many seconds to wait before timing out a webhook.

Required range: 0 <= x <= 30

Example:

25

data.inbound

object

Show child attributes

data.inbound.channel_limit

integer

When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.

Example:

10

data.outbound

object

Show child attributes

data.outbound.channel_limit

integer

When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.

Example:

10

data.outbound.outbound_voice_profile_id

string<int64>

Identifies the associated outbound voice profile.

Example:

"1293384261075731499"

data.created_at

string

ISO 8601 formatted date indicating when the resource was created.

Example:

"2018-02-02T22:25:27.521Z"

data.updated_at

string

ISO 8601 formatted date indicating when the resource was updated.

Example:

"2018-02-02T22:25:27.521Z"

Example:

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

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup