Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Telnyx

Telnyx External Connections API

External Connections operations

Documentation Provider Profile APIs.io OpenAPI GitHub

Telnyx External Connections API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include External Connections. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 23 operations across 17 paths, and defines 23 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

23 operations 17 paths 23 schemas 2 DELETE13 GET3 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
support@telnyx.com
Resource Areas
1

Authentication & Security 6

Telnyx External Connections API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 23

Across 17 paths, the API surfaces 23 operations — 2 DELETE, 13 GET, 3 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

External Connections 23

External Connections operations

GET
/external_connections
List all External Connections
ListExternalConnections 2 params → 200400401404
POST
/external_connections
Creates an External Connection
CreateExternalConnection body → 201422
GET
/external_connections/log_messages
List all log messages
ListExternalConnectionLogMessages 2 params → 200401422
DELETE
/external_connections/log_messages/{id}
Dismiss a log message
DeleteExternalConnectionLogMessage 1 param → 200401404
GET
/external_connections/log_messages/{id}
Retrieve a log message
GetExternalConnectionLogMessage 1 param → 200401404
DELETE
/external_connections/{id}
Deletes an External Connection
DeleteExternalConnection 1 param → 200401404422
GET
/external_connections/{id}
Retrieve an External Connection
GetExternalConnection 1 param → 200401404422
PATCH
/external_connections/{id}
Update an External Connection
UpdateExternalConnection 1 param body → 200401404422
GET
/external_connections/{id}/civic_addresses
List all civic addresses and locations
ListCivicAddresses 2 params → 200401404500502
GET
/external_connections/{id}/civic_addresses/{address_id}
Retrieve a Civic Address
GetExternalConnectionCivicAddress 2 params → 200401404500502
PATCH
/external_connections/{id}/locations/{location_id}
Update a location's static emergency address
updateLocation 2 params body → 200202404422
GET
/external_connections/{id}/phone_numbers
List all phone numbers
ListExternalConnectionPhoneNumbers 3 params → 200401404422
GET
/external_connections/{id}/phone_numbers/{phone_number_id}
Retrieve a phone number
GetExternalConnectionPhoneNumber 2 params → 200401404
PATCH
/external_connections/{id}/phone_numbers/{phone_number_id}
Update a phone number
UpdateExternalConnectionPhoneNumber 2 params body → 200401404422
GET
/external_connections/{id}/releases
List all Releases
ListExternalConnectionReleases 3 params → 200401404422
GET
/external_connections/{id}/releases/{release_id}
Retrieve a Release request
GetExternalConnectionRelease 2 params → 200401404
GET
/external_connections/{id}/uploads
List all Upload requests
ListExternalConnectionUploads 3 params → 200401404422
POST
/external_connections/{id}/uploads
Creates an Upload request
CreateExternalConnectionUpload 1 param body → 202401404413422504
POST
/external_connections/{id}/uploads/refresh
Refresh the status of all Upload requests
RefreshExternalConnectionUploads 1 param → 200401404409
GET
/external_connections/{id}/uploads/status
Get the count of pending upload requests
GetExternalConnectionUploadsStatus 1 param → 200401404
GET
/external_connections/{id}/uploads/{ticket_id}
Retrieve an Upload request
GetExternalConnectionUpload 2 params → 200401404
POST
/external_connections/{id}/uploads/{ticket_id}/retry
Retry an Upload request
RetryUpload 2 params → 202401404409422
POST
/operator_connect/actions/refresh
Refresh Operator Connect integration
OperatorConnectRefresh → 200202401

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are CivicAddress (16 properties), ExternalConnection (14 properties), Upload (8 properties), CreateExternalConnectionRequest (8 properties). Each schema is shown below with its type and property counts.

UpdateExternalConnectionPhoneNumberRequest
object
1 property
external-voice-integrations_OutboundVoiceProfileId
string
Identifies the associated outbound voice profile.
CreateExternalConnectionUploadRequest
object
5 properties 1 required
CreateExternalConnectionRequest
object
8 properties 2 required
ExternalConnectionPhoneNumber
object
7 properties
CredentialActive
boolean
If the credential associated with this service is active.
TnUploadEntry
object
8 properties
ExternalSipConnectionZoomOnly
string
The service that will be consuming this connection.
ExternalConnection
object
14 properties
Location
object
4 properties
ExternalSipConnection
string
The service that will be consuming this connection.
ConnectionActive
boolean
Specifies whether the connection can be used.
ErrorResponse
object
1 property
Upload
object
8 properties
external-voice-integrations_IntId
string
Uniquely identifies the resource.
LocationResponse
object
1 property
UpdateExternalConnectionRequest
object
7 properties 1 required
UUID
string
Uniquely identifies the resource.
LogMessage
object
5 properties 2 required
external-voice-integrations_PaginationMeta
object
4 properties
TnReleaseEntry
object
2 properties
Release
object
6 properties
CivicAddress
object
16 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-external-connections-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
AE Profile APIs.io
Telnyx Addresses API
AE Profile APIs.io
Telnyx Advanced Number Orders API
AE Profile APIs.io
Telnyx Assistants API
AE Profile APIs.io
Telnyx Audio API
AE Profile APIs.io
Telnyx Audit Logs API
AE Profile APIs.io
Telnyx Authentication Providers API
AE Profile APIs.io
Telnyx AutoRechargePreferences API
AE Profile APIs.io
Telnyx Billing API
AE Profile APIs.io
Telnyx Billing Groups API
AE Profile APIs.io
Telnyx Brands API
AE Profile APIs.io
Telnyx Bucket SSL Certificate API
AE Profile APIs.io
#External Connections
← Back to T APIs
API Details
ID
telnyx:telnyx-external-connections-api
Base URL
https://api.telnyx.com/v2
Docs
https://developers.telnyx.com/api
Provider
Telnyx
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network