Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/telnyx-uac-connections-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
contact:
email: support@telnyx.com
description: Telnyx provides global communications and connectivity APIs for developers — including SIP trunking, programmable voice, SMS, MMS, WhatsApp Business Messaging, Call Control, Fax, Wireless (IoT & eSIM), Phone Numbers (DID provisioning & porting), Emergency Services, and Network APIs for private interconnects and edge connectivity. Build, scale, and manage voice, messaging, and data networks with Telnyx's carrier-grade global infrastructure and API-first platform.
title: Telnyx UAC Connections API
version: 2.0.0
x-endpoint-cost: light
servers:
- description: Version 2.0.0 of the Telnyx API
url: https://api.telnyx.com/v2
security:
- bearerAuth: []
tags:
- description: UAC connection operations
name: UAC Connections
paths:
/uac_connections:
get:
description: Returns a list of your UAC connections. 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 PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the registration.
operationId: ListUacConnections
parameters:
- $ref: '#/components/parameters/connections_FilterConsolidated'
- $ref: '#/components/parameters/connections_PageConsolidated'
- $ref: '#/components/parameters/connections_SortConnection'
responses:
'200':
$ref: '#/components/responses/ListUacConnectionsResponse'
'400':
$ref: '#/components/responses/connections_BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthenticatedResponse'
'403':
$ref: '#/components/responses/connections_UnauthorizedResponse'
summary: List UAC connections
tags:
- UAC Connections
x-endpoint-cost: medium
x-group-parameters: 'true'
x-latency-category: responsive
post:
description: Creates a UAC connection. 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 PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the registration.
operationId: CreateUacConnection
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateUacConnectionRequest'
description: Parameters that can be defined during UAC connection creation
required: true
responses:
'201':
$ref: '#/components/responses/UacConnectionResponse'
'401':
$ref: '#/components/responses/UnauthenticatedResponse'
'403':
$ref: '#/components/responses/connections_UnauthorizedResponse'
'422':
$ref: '#/components/responses/connections_UnprocessableEntityResponse'
summary: Create a UAC connection
tags:
- UAC Connections
x-endpoint-cost: medium
x-latency-category: responsive
/uac_connections/{id}:
delete:
description: Deletes an existing UAC connection.
operationId: DeleteUacConnection
parameters:
- description: Identifies the resource.
in: path
name: id
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/UacConnectionResponse'
'400':
$ref: '#/components/responses/connections_BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthenticatedResponse'
'403':
$ref: '#/components/responses/connections_UnauthorizedResponse'
'404':
$ref: '#/components/responses/connections_NotFoundResponse'
summary: Delete a UAC connection
tags:
- UAC Connections
x-latency-category: responsive
get:
description: Retrieves the details of an existing UAC connection.
operationId: RetrieveUacConnection
parameters:
- description: Identifies the resource.
in: path
name: id
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/UacConnectionResponse'
'400':
$ref: '#/components/responses/connections_BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthenticatedResponse'
'403':
$ref: '#/components/responses/connections_UnauthorizedResponse'
'404':
$ref: '#/components/responses/connections_NotFoundResponse'
summary: Retrieve a UAC connection
tags:
- UAC Connections
x-latency-category: responsive
patch:
description: Updates settings of an existing UAC connection.
operationId: UpdateUacConnection
parameters:
- description: Identifies the resource.
in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUacConnectionRequest'
description: Parameters that can be updated in a UAC connection
required: true
responses:
'200':
$ref: '#/components/responses/UacConnectionResponse'
'401':
$ref: '#/components/responses/UnauthenticatedResponse'
'403':
$ref: '#/components/responses/connections_UnauthorizedResponse'
'404':
$ref: '#/components/responses/connections_NotFoundResponse'
'422':
$ref: '#/components/responses/connections_UnprocessableEntityResponse'
summary: Update a UAC connection
tags:
- UAC Connections
x-latency-category: responsive
/uac_connections/{id}/actions/check_registration_status:
post:
description: Checks the registration status for a UAC connection (`registration_status`) as well as the timestamp for the last SIP registration event (`registration_status_updated_at`).
operationId: CheckUacConnectionRegistrationStatus
parameters:
- description: Identifies the resource.
in: path
name: id
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/RegistrationStatusResponse'
'400':
$ref: '#/components/responses/connections_BadRequestResponse'
'401':
$ref: '#/components/responses/UnauthenticatedResponse'
'403':
$ref: '#/components/responses/connections_UnauthorizedResponse'
'404':
$ref: '#/components/responses/connections_NotFoundResponse'
summary: Check a UAC Connection Registration Status
tags:
- UAC Connections
x-latency-category: responsive
components:
schemas:
UacInboundRequest:
description: Inbound settings that can be supplied when creating or updating a UAC connection. The SIP subdomain fields returned in UAC connection responses are generated by Telnyx and are not accepted as request parameters.
example:
ani_number_format: +E.164
channel_limit: 10
codecs:
- G722
default_routing_method: sequential
dnis_number_format: +e164
generate_ringback_tone: true
isup_headers_enabled: true
prack_enabled: true
shaken_stir_enabled: true
simultaneous_ringing: enabled
sip_compact_headers_enabled: true
timeout_1xx_secs: 10
timeout_2xx_secs: 20
properties:
ani_number_format:
default: E.164-national
description: This setting allows you to set the format with which the caller's number (ANI) is sent for inbound phone calls.
enum:
- +E.164
- E.164
- +E.164-national
- E.164-national
type: string
channel_limit:
default: null
description: When set, this will limit the total number of inbound calls to phone numbers associated with this connection.
type: integer
codecs:
default:
- G722
- G711U
- G711A
- G729
- OPUS
- H.264
description: 'Defines the list of codecs that Telnyx will send for inbound calls to a specific number on your portal account, in priority order. This only works when the Connection the number is assigned to uses Media Handling mode: default. OPUS and H.264 codecs are available only when using TCP or TLS transport for SIP.'
items:
type: string
type: array
default_routing_method:
description: Default routing method to be used when a number is associated with the connection. Must be one of the routing method types or left blank, other values are not allowed.
enum:
- sequential
- round-robin
type: string
dnis_number_format:
default: e164
enum:
- +e164
- e164
- national
- sip_username
type: string
generate_ringback_tone:
default: false
description: Generate ringback tone through 183 session progress message with early media.
type: boolean
isup_headers_enabled:
default: false
description: When set, inbound phone calls will receive ISUP parameters via SIP headers. (Only when available and only when using TCP or TLS transport.)
type: boolean
prack_enabled:
default: false
description: Enable PRACK messages as defined in RFC3262.
type: boolean
shaken_stir_enabled:
default: false
description: When enabled the SIP Connection will receive the Identity header with Shaken/Stir data in the SIP INVITE message of inbound calls, even when using UDP transport.
type: boolean
simultaneous_ringing:
default: disabled
description: When enabled, allows multiple devices to ring simultaneously on incoming calls.
enum:
- disabled
- enabled
type: string
sip_compact_headers_enabled:
default: true
description: Defaults to true.
type: boolean
timeout_1xx_secs:
default: 3
description: Time(sec) before aborting if connection is not made.
maximum: 120
minimum: 1
type: integer
timeout_2xx_secs:
default: 90
description: 'Time(sec) before aborting if call is unanswered (min: 1, max: 600).'
maximum: 600
minimum: 1
type: integer
title: UAC Inbound Request
type: object
ConnectionJitterBuffer:
description: 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 max values in msec for customized buffering behaviors. Larger values add latency but tolerate more jitter, while smaller values reduce latency but are more sensitive to jitter and reordering.
properties:
enable_jitter_buffer:
default: false
description: Enables Jitter Buffer for RTP streams of SIP Trunking calls. The feature is off unless enabled.
example: true
type: boolean
jitterbuffer_msec_max:
default: 200
description: The maximum jitter buffer size in milliseconds. Must be between 40 and 400. Has no effect if enable_jitter_buffer is not true.
example: 200
maximum: 400
minimum: 40
type: integer
jitterbuffer_msec_min:
default: 60
description: The minimum jitter buffer size in milliseconds. Must be between 40 and 400. Has no effect if enable_jitter_buffer is not true.
example: 60
maximum: 400
minimum: 40
type: integer
type: object
DtmfType:
default: RFC 2833
description: 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.
enum:
- RFC 2833
- Inband
- SIP INFO
example: Inband
title: DTMF Type
type: string
AnchorsiteOverride:
default: Latency
description: '`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 messages. This can be disabled by specifying a site to handle all media.'
enum:
- Latency
- Chicago, IL
- Ashburn, VA
- San Jose, CA
- Sydney, Australia
- Amsterdam, Netherlands
- London, UK
- Toronto, Canada
- Vancouver, Canada
- Frankfurt, Germany
example: Amsterdam, Netherlands
title: Anchorsite Override
type: string
UacInternalSettings:
description: Internal Telnyx-side settings for a UAC connection.
example:
destination_uri: 14155550123@acme.sip.telnyx.com
properties:
destination_uri:
description: The SIP URI that Telnyx will call when handling an inbound request from the external peer. Do not include a `sip:` prefix. The value must be in the format `userinfo@<subdomain.>sip.telnyx.com` or `userinfo@<subdomain.>sipdev.telnyx.com`; the userinfo portion may contain only letters, digits, hyphens, and underscores.
example: 14155550123@acme.sip.telnyx.com
type: string
title: UAC Internal Settings
type: object
Fqdn:
example:
connection_id: '1516447646313612565'
created_at: '2018-02-02T22:25:27.521Z'
dns_record_type: a
fqdn: example.com
id: '1293384261075731499'
port: 5060
record_type: fqdn
updated_at: '2018-02-02T22:25:27.521Z'
properties:
connection_id:
description: ID of the FQDN connection to which this FQDN is attached.
type: string
created_at:
description: ISO 8601 formatted date indicating when the resource was created.
example: '2018-02-02T22:25:27.521Z'
type: string
dns_record_type:
description: The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used.
example: a
type: string
fqdn:
description: FQDN represented by this resource.
example: example.com
type: string
id:
description: Identifies the resource.
example: '1293384261075731499'
type: string
x-format: int64
port:
default: 5060
description: Port to use when connecting to this FQDN.
example: 5060
type: integer
record_type:
description: Identifies the type of the resource.
example: fqdn
type: string
updated_at:
description: ISO 8601 formatted date indicating when the resource was updated.
example: '2018-02-02T22:25:27.521Z'
type: string
title: Fqdn
type: object
UacConnection:
description: 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 PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the registration.
example:
active: true
anchorsite_override: Latency
android_push_credential_id: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e
authentication: uac-authentication
call_cost_in_webhooks: false
connection_name: string
created_at: '2018-02-02T22:25:27.521Z'
default_on_hold_comfort_noise_enabled: true
dtmf_type: RFC 2833
encode_contact_header_enabled: true
encrypted_media: SRTP
external_uac_settings:
auth_username: auth8492
expiration_sec: 600
from_user: '8492'
outbound_proxy: outbound.sip-pbx.acme.example:5061
password: testtesttest
proxy: sip-pbx.acme.example
transport: TLS
username: ext8492
fqdn: abc123def456.uac.telnyx.com
fqdn_outbound_authentication: credential-authentication
fqdns:
- connection_id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
created_at: '2018-02-02T22:25:27.521Z'
dns_record_type: srv
fqdn: abc123def456.uac.telnyx.com
id: '1293384261075731499'
port: 5060
record_type: fqdn
updated_at: '2018-02-02T22:25:27.521Z'
id: 6a09cdc3-8948-47f0-aa62-74ac943d6c58
inbound:
ani_number_format: +E.164
channel_limit: 10
codecs:
- G722
dnis_number_format: +e164
generate_ringback_tone: true
isup_headers_enabled: true
prack_enabled: true
shaken_stir_enabled: true
simultaneous_ringing: enabled
sip_compact_headers_enabled: true
timeout_1xx_secs: 10
timeout_2xx_secs: 15
internal_uac_settings:
destination_uri: 14155550123@acme.sip.telnyx.com
ios_push_credential_id: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836
jitter_buffer:
enable_jitter_buffer: true
jitterbuffer_msec_max: 200
jitterbuffer_msec_min: 60
noise_suppression: both
noise_suppression_details:
attenuation_limit: 80
engine: deep_filter_net
onnet_t38_passthrough_enabled: true
outbound:
ani_override: string
ani_override_type: always
call_parking_enabled: true
channel_limit: 10
generate_ringback_tone: true
instant_ringback_enabled: true
localization: string
outbound_voice_profile_id: '1293384261075731499'
t38_reinvite_source: customer
password: my123secure456password789
record_type: uac_connection
registration_status: Registered
registration_status_updated_at: '2018-02-02T22:25:27.521Z'
rtcp_settings:
capture_enabled: true
port: rtp+1
report_frequency_secs: 10
sip_uri_calling_preference: disabled
tags:
- tag1
- tag2
updated_at: '2018-02-02T22:25:27.521Z'
user_name: myusername123
webhook_api_version: '1'
webhook_event_failover_url: https://failover.example.com
webhook_event_url: https://example.com
webhook_timeout_secs: 25
properties:
active:
description: Defaults to true
type: boolean
anchorsite_override:
$ref: '#/components/schemas/AnchorsiteOverride'
android_push_credential_id:
$ref: '#/components/schemas/ConnectionAndroidPushCredentialId'
authentication:
description: The authentication strategy used by this connection.
enum:
- uac-authentication
example: uac-authentication
type: string
call_cost_in_webhooks:
default: false
description: Specifies if call cost webhooks should be sent for this connection.
type: boolean
connection_name:
type: string
created_at:
description: ISO-8601 formatted date indicating when the resource was created.
example: '2018-02-02T22:25:27.521Z'
type: string
default_on_hold_comfort_noise_enabled:
default: true
description: When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
type: boolean
dtmf_type:
$ref: '#/components/schemas/DtmfType'
encode_contact_header_enabled:
default: false
description: Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
type: boolean
encrypted_media:
$ref: '#/components/schemas/EncryptedMedia'
external_uac_settings:
$ref: '#/components/schemas/UacExternalSettings'
fqdn:
description: The Telnyx-managed FQDN generated for the UAC connection.
example: abc123def456.uac.telnyx.com
type: string
fqdn_outbound_authentication:
description: The fixed outbound authentication mode used by UAC FQDN records.
enum:
- credential-authentication
example: credential-authentication
type: string
fqdns:
description: FQDN records managed automatically by the UAC connection lifecycle.
items:
$ref: '#/components/schemas/Fqdn'
type: array
id:
description: Identifies the type of resource.
example: '1293384261075731499'
type: string
x-format: int64
inbound:
$ref: '#/components/schemas/UacInbound'
internal_uac_settings:
$ref: '#/components/schemas/UacInternalSettings'
ios_push_credential_id:
$ref: '#/components/schemas/ConnectionIosPushCredentialId'
jitter_buffer:
$ref: '#/components/schemas/ConnectionJitterBuffer'
noise_suppression:
$ref: '#/components/schemas/ConnectionNoiseSuppression'
noise_suppression_details:
$ref: '#/components/schemas/ConnectionNoiseSuppressionDetails'
onnet_t38_passthrough_enabled:
default: false
description: Enable on-net T38 if you prefer the sender and receiver negotiating T38 directly if both are on the Telnyx network. If this is disabled, Telnyx will be able to use T38 on just one leg of the call depending on each leg's settings.
type: boolean
outbound:
$ref: '#/components/schemas/UacOutbound'
password:
description: The password to be used as part of the credentials. Must be 8 to 128 characters long.
example: my123secure456password789
type: string
record_type:
description: Identifies the type of the resource.
example: uac_connection
type: string
registration_status:
description: The most recently known SIP registration status for this UAC connection.
example: Registered
type:
- string
- 'null'
registration_status_updated_at:
description: ISO 8601 formatted date indicating when the registration status was last updated.
example: '2018-02-02T22:25:27.521Z'
type:
- string
- 'null'
rtcp_settings:
$ref: '#/components/schemas/ConnectionRtcpSettings'
sip_uri_calling_preference:
description: This feature enables inbound SIP URI calls to your Credential Auth Connection. If enabled for all (unrestricted) then anyone who calls the SIP URI <your-username>@telnyx.com will be connected to your Connection. You can also choose to allow only calls that are originated on any Connections under your account (internal).
enum:
- disabled
- unrestricted
- internal
example: disabled
type: string
tags:
description: Tags associated with the connection.
example:
- tag1
- tag2
items:
type: string
type: array
updated_at:
description: ISO-8601 formatted date indicating when the resource was updated.
example: '2018-02-02T22:25:27.521Z'
type: string
user_name:
description: The user name to be used as part of the credentials. Must be 4-32 characters long and alphanumeric values only (no spaces or special characters). At least one of the first 5 characters must be a letter.
example: myusername123
type: string
webhook_api_version:
default: '1'
description: Determines which webhook format will be used, Telnyx API v1 or v2.
enum:
- '1'
- '2'
example: '1'
type: string
webhook_event_failover_url:
default: ''
description: 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
format: uri
type:
- string
- 'null'
webhook_event_url:
description: The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.
example: https://example.com
format: uri
type: string
webhook_timeout_secs:
default: null
description: Specifies how many seconds to wait before timing out a webhook.
example: 25
maximum: 30
minimum: 0
type:
- integer
- 'null'
title: UAC Connection
type: object
EncryptedMedia:
description: Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TLS.
enum:
- SRTP
- null
example: SRTP
type:
- string
- 'null'
ErrorResponse:
properties:
errors:
items:
properties:
code:
type: string
detail:
type: string
meta:
properties:
url:
format: uri
type: string
type: object
source:
properties:
pointer:
type: string
type: object
title:
type: string
type: object
type: array
type: object
UacExternalSettings:
description: External SIP peer settings used by Telnyx when registering to your PBX and routing outbound calls.
example:
auth_username: auth8492
expiration_sec: 600
from_user: '8492'
outbound_proxy: outbound.sip-pbx.acme.example:5061
password: testtesttest
proxy: sip-pbx.acme.example
transport: TLS
username: ext8492
properties:
auth_username:
description: The authentication username used in SIP digest authentication. If not set, the Username value will be used.
example: auth8492
type:
- string
- 'null'
expiration_sec:
description: The registration interval, in seconds, indicating how often the system refreshes the SIP registration with the external SIP peer.
example: 600
minimum: 1
type:
- integer
- 'null'
from_user:
description: The user portion of the SIP From header used in outbound requests. This controls the caller identity presented to the external SIP peer.
example: '8492'
type:
- string
- 'null'
outbound_proxy:
description: An optional SIP proxy used to route outbound requests before reaching the external SIP peer.
example: outbound.sip-pbx.acme.example:5061
type:
- string
- 'null'
password:
description: The SIP password used for digest authentication with the external SIP peer.
example: testtesttest
type: string
proxy:
description: The SIP proxy address of the external SIP peer used for registrations and outbound call routing.
example: sip-pbx.acme.example
type: string
transport:
description: The transport protocol used for SIP signaling when communicating with the external SIP peer. One of UDP, TLS, or TCP.
enum:
- UDP
- TLS
- TCP
- null
example: TLS
type:
- string
- 'null'
username:
description: The SIP username used to authenticate with the external SIP peer for registrations and outbound calls. Must start with a letter or number and contain only letters, numbers, hyphens, and underscores.
example: ext8492
maxLength: 32
minLength: 4
type: string
title: UAC External Settings
type: object
UpdateUacConnectionRequest:
description: 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, where the PBX registers to Telnyx. Use UAC when your PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the registration.
example:
active: true
anchorsite_override: Latency
android_push_credential_id: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e
call_cost_in_webhooks: false
connection_name: my name
default_on_hold_comfort_noise_enabled: false
dtmf_type: RFC 2833
encode_contact_header_enabled: true
encrypted_media: SRTP
external_uac_settings:
auth_username: auth8492
expiration_sec: 600
from_user: '8492'
outbound_proxy: outbound.sip-pbx.acme.example:5061
password: testtesttest
proxy: sip-pbx.acme.example
transport: TLS
username: ext8492
inbound:
ani_number_format: +E.164
channel_limit: 10
codecs:
- G722
dnis_number_format: +e164
generate_ringback_tone: true
isup_headers_enabled: true
prack_enabled: true
shaken_stir_enabled: true
simultaneous_ringing: disabled
sip_compact_headers_enabled: true
timeout_1xx_secs: 10
timeout_2xx_secs: 20
internal_uac_settings:
destination_uri: 14155550123@acme.sip.telnyx.com
ios_push_credential_id: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836
jitter_buffer:
enable_jitter_buffer: true
jitterbuffer_msec_max: 200
jitterbuffer_msec_min: 60
noise_suppression: both
noise_suppression_details:
attenuation_limit: 80
engine: deep_filter_net
onnet_t38_passthrough_enabled: true
outbound:
ani_override: always
call_parking_enabled: true
channel_limit: 10
generate_ringback_tone: true
instant_ringback_enabled: true
localization: US
outbound_voice_profile_id: '1293384261075731499'
t38_reinvite_source: customer
password: my123secure456password789
rtcp_settings:
capture_enabled: true
port: rtcp-mux
report_frequency_secs: 10
sip_uri_calling_preference: disabled
tags:
- tag1
- tag2
user_name: myusername123
webhook_api_version: '1'
webhook_event_failover_url: https://failover.example.com
webhook_event_url: https://example.com
webhook_timeout_secs: 25
properties:
active:
description: Defaults to true
type: boolean
anchorsite_override:
$ref: '#/components/schemas/AnchorsiteOverride'
android_push_credential_id:
$ref: '#/components/schemas/ConnectionAndroidPushCredentialId'
call_cost_in_webhooks:
default: false
description: Specifies if call cost webhooks should be sent for this connection.
type: boolean
connection_name:
$ref: '#/components/schemas/ConnectionName'
default_on_hold_comfort_noise_enabled:
default: false
description: When enabled, Telnyx will generate comfort noise when you place the call on hold. If disabled, you will need to generate comfort noise or on hold music to avoid RTP timeout.
type: boolean
dtmf_type:
$ref: '#/components/schemas/DtmfType'
encode_contact_header_enabled:
default: false
description: Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.
type: boolean
encrypted_media:
$ref: '#/components/schemas/EncryptedMedia'
external_uac_settings:
# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/telnyx/refs/heads/main/openapi/telnyx-uac-connections-api-openapi.yml