openapi: 3.1.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 Access Tokens 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: responses: UacConnectionResponse: content: application/json: schema: properties: data: $ref: '#/components/schemas/UacConnection' title: UAC Connection Response type: object description: Successful response with details about a UAC connection. connections_NotFoundResponse: content: application/json: examples: notFound: value: errors: - code: '10005' detail: The requested resource or URL could not be found. meta: url: https://developers.telnyx.com/docs/overview/errors/10005 source: pointer: / title: Resource not found schema: $ref: '#/components/schemas/ErrorResponse' description: The requested resource doesn't exist. ListUacConnectionsResponse: content: application/json: schema: properties: data: items: $ref: '#/components/schemas/UacConnection' type: array meta: $ref: '#/components/schemas/connections_PaginationMeta' title: List UAC Connections Response type: object description: Successful response with a list of UAC connections. RegistrationStatusResponse: content: application/json: schema: properties: data: example: ip_address: 190.106.106.121 last_registration: '2021-09-28T15:11:02' port: 37223 record_type: registration_status sip_username: rogerp status: Expired transport: UDP user_agent: Z 5.4.12 v2.10.13.2-mod properties: ip_address: description: The ip used during the SIP connection example: 190.106.106.121 type: string last_registration: description: ISO 8601 formatted date indicating when the resource was last updated. example: '2018-02-02T22:25:27.521Z' type: string port: description: The port of the SIP connection example: 37223 type: integer record_type: description: Identifies the type of the resource. example: registration_status type: string sip_username: description: The user name of the SIP connection example: sip_username type: string status: description: The current registration status of your SIP connection enum: - Not Applicable - Not Registered - Failed - Expired - Registered - Unregistered type: string transport: description: The protocol of the SIP connection example: TCP type: string user_agent: description: The user agent of the SIP connection example: Z 5.4.12 v2.10.13.2-mod type: string title: Registration Status type: object title: Registration Status Response type: object description: Successful response with details about a credential connection registration status. UnauthenticatedResponse: content: application/json: examples: Authentication Failed: value: errors: - code: '10009' detail: Could not understand the provided credentials. meta: url: https://developers.telnyx.com/docs/overview/errors/10009 title: Authentication failed schema: $ref: '#/components/schemas/ErrorResponse' description: Unauthorized connections_BadRequestResponse: content: application/json: examples: missingParameter: value: errors: - code: '10015' detail: The request failed because it was not well-formed. meta: url: https://developers.telnyx.com/docs/overview/errors/10015 source: pointer: / title: Bad Request schema: $ref: '#/components/schemas/ErrorResponse' description: Bad request, the request was unacceptable, often due to missing a required parameter. connections_UnauthorizedResponse: content: application/json: examples: notAuthorized: value: errors: - code: '10010' detail: You are not authorized to access the requested resource. meta: url: https://developers.telnyx.com/docs/overview/errors/10010 source: pointer: / title: Not authorized schema: $ref: '#/components/schemas/ErrorResponse' description: The user doesn't have the required permissions to perform the requested action. connections_UnprocessableEntityResponse: content: application/json: examples: unprocessableEntity: value: errors: - code: '10015' detail: 'Invalid dnis_format: test, was provided. Acceptable formats are +e164, e164, national, sip_username' meta: url: https://developers.telnyx.com/docs/overview/errors/10015 source: pointer: /inbound/dnis_number_format title: Bad Request schema: $ref: '#/components/schemas/ErrorResponse' description: The request was well-formed but was unable to be followed due to semantic errors. 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 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 connections_PaginationMeta: properties: page_number: example: 2 type: integer page_size: example: 25 type: integer total_pages: example: 3 type: integer total_results: example: 55 type: integer title: Pagination Meta 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' CreateUacConnectionRequest: 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 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 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: $ref: '#/components/schemas/UacExternalSettings' inbound: $ref: '#/components/schemas/UacInboundRequest' 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 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 @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 type: string tags: description: Tags associated with the connection. example: - tag1 - tag2 items: type: string type: array 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). example: myusername123 type: string webhook_api_version: default: '1' description: Determines which webhook format will be used, Telnyx API v1, v2 or texml. Note - texml can only be set when the outbound object parameter call_parking_enabled is included and set to true. enum: - '1' - '2' - texml 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' required: - connection_name title: Create UAC Connection Request type: object 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 ConnectionNoiseSuppression: description: 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 applied to outgoing audio. When set to 'both', it's applied in both directions. When set to 'disabled', noise suppression is turned off. enum: - inbound - outbound - both - disabled example: both type: string ConnectionAndroidPushCredentialId: default: null description: The uuid of the push credential for Android example: 06b09dfd-7154-4980-8b75-cebf7a9d4f8e title: Android Push Credential Id type: - string - 'null' 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 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: $ref: '#/components/schemas/UacExternalSettings' inbound: $ref: '#/components/schemas/UacInboundRequest' 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 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 @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 type: string tags: description: Tags associated with the connection. example: - tag1 - tag2 items: type: string type: array 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). 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: Update UAC Connection Request 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 @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 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 ConnectionIosPushCredentialId: default: null description: The uuid of the push credential for Ios example: ec0c8e5d-439e-4620-a0c1-9d9c8d02a836 title: Ios Push Credential Id type: - string - 'null' 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@sip.telnyx.com` or `userinfo@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 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 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 connections_OutboundVoiceProfileId: description: Identifies the associated outbound voice profile. example: '1293384261075731499' title: Outbound Voice Profile ID type: string x-format: int64 ConnectionNoiseSuppressionDetails: description: Configuration options for noise suppression. These settings are stored regardless of the noise_suppression value, but only take effect when noise_suppression is not 'disabled'. If you disable noise suppression and later re-enable it, the previously configured settings will be used. properties: attenuation_limit: description: 'The attenuation limit value for the selected engine. Default values vary by engine: 0 for ''denoiser'', 80 for ''deep_filter_net'', ''deep_filter_net_large'', and all Krisp engines (''krisp_viva_tel'', ''krisp_viva_tel_lite'', ''krisp_viva_promodel'', ''krisp_viva_ss''), 100 for ''quail_voice_focus''.' example: 80 maximum: 100 minimum: 0 multipleOf: 10 type: integer engine: default: denoiser description: The noise suppression engine to use. 'denoiser' is the default engine. 'deep_filter_net' and 'deep_filter_net_large' are alternative engines with different performance characteristics. Krisp engines ('krisp_viva_tel', 'krisp_viva_tel_lite', 'krisp_viva_promodel', 'krisp_viva_ss') provide advanced noise suppression capabilities. 'quail_voice_focus' provides Quail-based voice focus noise suppression. enum: - denoiser - deep_filter_net - deep_filter_net_large - krisp_viva_tel - krisp_viva_tel_lite - krisp_viva_promodel - krisp_viva_ss - quail_voice_focus example: deep_filter_net type: string type: object UacOutbound: example: 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 properties: ani_override: default: '' description: Set a phone number as the ani_override value to override caller id number on outbound calls. type: string ani_override_type: default: always description: Specifies when we apply your ani_override setting. Only applies when ani_override is not blank. enum: - always - normal - emergency type: string call_parking_enabled: default: false description: Forces all SIP calls originated on this connection to be "parked" instead of "bridged" to the destination specified on the URI. Parked calls will return ringback to the caller and will await for a Call Control command to define which action will be taken next. type: - boolean - 'null' channel_limit: default: null description: When set, this will limit the total number of outbound calls to phone numbers associated with this connection. type: integer generate_ringback_tone: default: false description: Generate ringback tone through 183 session progress message with early media. type: boolean instant_ringback_enabled: default: true description: When set, ringback will not wait for indication before sending ringback tone to calling party. type: boolean localization: default: US description: A 2-character country code specifying the country whose national dialing rules should be used. For example, if set to `US` then any US number can be dialed without preprending +1 to the number. When left blank, Telnyx will try US and GB dialing rules, in that order, by default. example: US type: string outbound_voice_profile_id: $ref: '#/components/schemas/connections_OutboundVoiceProfileId' t38_reinvite_source: default: telnyx description: This setting only affects connections with Fax-type Outbound Voice Profiles. The setting dictates whether or not Telnyx sends a t.38 reinvite.

By default, Telnyx will send the re-invite. If set to `customer`, the caller is expected to send the t.38 reinvite. enum: - telnyx - customer - disabled - passthru - caller-passthru - callee-passthru type: string title: UAC Outbound type: object ConnectionRtcpSettings: example: capture_enabled: true port: rtcp-mux report_frequency_secs: 10 properties: capture_enabled: default: false description: BETA - Enable the capture and storage of RTCP messages to create QoS reports on the Telnyx Mission Control Portal. example: true type: boolean port: default: rtp+1 description: RTCP port by default is rtp+1, it can also be set to rtcp-mux enum: - rtcp-mux - rtp+1 type: string report_frequency_secs: default: 5 description: RTCP reports are sent to customers based on the frequency set. Frequency is in seconds and it can be set to values from 5 to 3000 seconds. example: 10 type: integer title: Connection RTCP Settings type: object ConnectionName: description: A user-assigned name to help manage the connection. example: office-connection title: Connection Name type: string UacInbound: 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 sip_subdomain: abc123def456 sip_subdomain_receive_settings: only_my_connections 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 sip_subdomain: description: The Telnyx-generated SIP subdomain for this UAC connection. example: abc123def456 type: string sip_subdomain_receive_settings: description: Controls which SIP URI callers may reach this connection. enum: - only_my_connections - from_anyone example: only_my_connections type: string 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 type: object parameters: connections_PageConsolidated: description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]' explode: true in: query name: page schema: properties: number: default: 1 description: The page number to load minimum: 1 type: integer size: default: 250 description: The size of the page maximum: 250 minimum: 1 type: integer type: object style: deepObject connections_FilterConsolidated: description: 'Consolidated filter parameter (deepObject style). Originally: filter[connection_name], filter[fqdn], filter[outbound_voice_profile_id], filter[outbound.outbound_voice_profile_id]' explode: true in: query name: filter schema: properties: connection_name: description: Filter by connection_name using nested operations properties: contains: default: null description: If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters. type: string type: object fqdn: default: null description: If present, connections with an `fqdn` that equals the given value will be returned. Matching is case-sensitive, and the full string must match. type: string outbound_voice_profile_id: description: Identifies the associated outbound voice profile. example: '1293384261075731499' type: string x-format: int64 type: object style: deepObject connections_SortConnection: description: "Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

\nThat is:
    \n
  • \n connection_name: sorts the result by the\n connection_name field in ascending order.\n
    • \n\n
  • \n -connection_name: sorts the result by the\n connection_name field in descending order.\n
    • \n

If not given, results are sorted by created_at in descending order." in: query name: sort schema: default: created_at enum: - created_at - connection_name - active example: connection_name type: string securitySchemes: bearerAuth: scheme: bearer type: http branded-calling_bearerAuth: description: API key passed as a Bearer token in the Authorization header scheme: bearer type: http oauthClientAuth: description: OAuth 2.0 authentication for Telnyx API and MCP integrations flows: authorizationCode: authorizationUrl: https://api.telnyx.com/v2/oauth/authorize refreshUrl: https://api.telnyx.com/v2/oauth/token scopes: admin: Administrative access to Telnyx resources tokenUrl: https://api.telnyx.com/v2/oauth/token clientCredentials: scopes: admin: Administrative access to Telnyx resources tokenUrl: https://api.telnyx.com/v2/oauth/token type: oauth2 outbound-voice-profiles_bearerAuth: bearerFormat: JWT scheme: bearer type: http pronunciation-dicts_bearerAuth: description: Telnyx API v2 key. Obtain from https://portal.telnyx.com scheme: bearer type: http stored-payment-transactions_bearerAuth: bearerFormat: JWT scheme: bearer type: http