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 UAC Connections API

UAC connection operations

Documentation Provider Profile APIs.io OpenAPI GitHub

Telnyx UAC 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 UAC Connections. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 6 operations across 3 paths, and defines 22 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.

6 operations 3 paths 22 schemas 1 DELETE2 GET1 PATCH2 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 UAC 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 6

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

UAC Connections 6

UAC connection operations

GET
/uac_connections
List UAC connections
ListUacConnections 3 params → 200400401403
POST
/uac_connections
Create a UAC connection
CreateUacConnection body → 201401403422
DELETE
/uac_connections/{id}
Delete a UAC connection
DeleteUacConnection 1 param → 200400401403404
GET
/uac_connections/{id}
Retrieve a UAC connection
RetrieveUacConnection 1 param → 200400401403404
PATCH
/uac_connections/{id}
Update a UAC connection
UpdateUacConnection 1 param body → 200401403404422
POST
/uac_connections/{id}/actions/check_registration_status
Check a UAC Connection Registration Status
CheckUacConnectionRegistrationStatus 1 param → 200400401403404

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are UacConnection (37 properties), CreateUacConnectionRequest (27 properties), UpdateUacConnectionRequest (27 properties), UacInbound (15 properties). Each schema is shown below with its type and property counts.

UacInboundRequest
object
Inbound settings that can be supplied when creating or updating a UAC connection. The SIP subdomain fields returned in UAC connection responses are generated b…
13 properties
DtmfType
string
Sets the type of DTMF digits sent from Telnyx to this Connection. Note that DTMF digits sent to Telnyx will be accepted in all formats.
connections_PaginationMeta
object
4 properties
EncryptedMedia
stringnull
Enable use of SRTP for encryption. Cannot be set if the transportportocol is TLS.
CreateUacConnectionRequest
object
A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your…
27 properties 1 required
ErrorResponse
object
1 property
ConnectionNoiseSuppression
string
Controls when noise suppression is applied to calls. When set to 'inbound', noise suppression is applied to incoming audio. When set to 'outbound', it's applie…
ConnectionAndroidPushCredentialId
stringnull
The uuid of the push credential for Android
Fqdn
object
8 properties
UpdateUacConnectionRequest
object
Parameters that can be updated in a UAC connection. A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite of a standard SIP trunk, w…
27 properties
UacConnection
object
A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your…
37 properties
AnchorsiteOverride
string
Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping me…
ConnectionIosPushCredentialId
stringnull
The uuid of the push credential for Ios
UacInternalSettings
object
Internal Telnyx-side settings for a UAC connection.
1 property
UacExternalSettings
object
External SIP peer settings used by Telnyx when registering to your PBX and routing outbound calls.
8 properties
ConnectionJitterBuffer
object
Configuration options for Jitter Buffer. Enables Jitter Buffer for RTP streams of SIP Trunking calls. The feature is off unless enabled. You may define min and…
3 properties
connections_OutboundVoiceProfileId
string
Identifies the associated outbound voice profile.
ConnectionNoiseSuppressionDetails
object
Configuration options for noise suppression. These settings are stored regardless of the noisesuppression value, but only take effect when noisesuppression is…
2 properties
UacOutbound
object
9 properties
ConnectionRtcpSettings
object
3 properties
ConnectionName
string
A user-assigned name to help manage the connection.
UacInbound
object
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-uac-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
#UAC Connections
← Back to T APIs
API Details
ID
telnyx:telnyx-uac-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