Sign in
UAC Connections

Create a UAC connection

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.

post/uac_connections

Request body

activeboolean

Defaults to true

user_namestring

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).

passwordstring

The password to be used as part of the credentials. Must be 8 to 128 characters long.

anchorsite_override'Latency' | 'Chicago, IL' | 'Ashburn, VA' | 'San Jose, CA' | 'Sydney, Australia' | 'Amsterdam, Netherlands' | 'London, UK' | 'Toronto, Canada' | 'Vancouver, Canada' | 'Frankfurt, Germany'

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.

connection_namestring required

A user-assigned name to help manage the connection.

sip_uri_calling_preference'disabled' | 'unrestricted' | 'internal'

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).

default_on_hold_comfort_noise_enabledboolean

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.

dtmf_type'RFC 2833' | 'Inband' | 'SIP INFO'

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.

encode_contact_header_enabledboolean

Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG scenarios.

encrypted_media'SRTP' | 'null' nullable

Enable use of SRTP for encryption. Cannot be set if the transport_portocol is TLS.

onnet_t38_passthrough_enabledboolean

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.

ios_push_credential_idstring nullable

The uuid of the push credential for Ios

android_push_credential_idstring nullable

The uuid of the push credential for Android

webhook_event_urlstring uri

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

webhook_event_failover_urlstring uri nullable

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'.

webhook_api_version'1' | '2' | 'texml'

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.

webhook_timeout_secsinteger nullable

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

call_cost_in_webhooksboolean

Specifies if call cost webhooks should be sent for this connection.

tagsstring[]

Tags associated with the connection.

noise_suppression'inbound' | 'outbound' | 'both' | 'disabled'

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.

Example request

{
  "active": true,
  "password": "my123secure456password789",
  "user_name": "myusername123",
  "anchorsite_override": "Latency",
  "connection_name": "my name",
  "sip_uri_calling_preference": "disabled",
  "default_on_hold_comfort_noise_enabled": false,
  "dtmf_type": "RFC 2833",
  "encode_contact_header_enabled": true,
  "encrypted_media": "SRTP",
  "onnet_t38_passthrough_enabled": true,
  "ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836",
  "android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e",
  "webhook_event_url": "https://example.com",
  "webhook_event_failover_url": "https://failover.example.com",
  "webhook_api_version": "1",
  "webhook_timeout_secs": 25,
  "call_cost_in_webhooks": false,
  "rtcp_settings": {
    "port": "rtcp-mux",
    "capture_enabled": true,
    "report_frequency_secs": 10
  },
  "inbound": {
    "ani_number_format": "+E.164",
    "dnis_number_format": "+e164",
    "codecs": [
      "G722"
    ],
    "channel_limit": 10,
    "generate_ringback_tone": true,
    "isup_headers_enabled": true,
    "prack_enabled": true,
    "sip_compact_headers_enabled": true,
    "timeout_1xx_secs": 10,
    "timeout_2xx_secs": 20,
    "shaken_stir_enabled": true,
    "simultaneous_ringing": "disabled"
  },
  "outbound": {
    "call_parking_enabled": true,
    "ani_override": "always",
    "channel_limit": 10,
    "instant_ringback_enabled": true,
    "generate_ringback_tone": true,
    "localization": "US",
    "t38_reinvite_source": "customer",
    "outbound_voice_profile_id": "1293384261075731499"
  },
  "noise_suppression": "both",
  "noise_suppression_details": {
    "engine": "deep_filter_net",
    "attenuation_limit": 80
  },
  "jitter_buffer": {
    "enable_jitter_buffer": true,
    "jitterbuffer_msec_min": 60,
    "jitterbuffer_msec_max": 200
  },
  "internal_uac_settings": {
    "destination_uri": "14155550123@acme.sip.telnyx.com"
  },
  "external_uac_settings": {
    "username": "ext8492",
    "password": "testtesttest",
    "proxy": "sip-pbx.acme.example",
    "auth_username": "auth8492",
    "from_user": "8492",
    "outbound_proxy": "outbound.sip-pbx.acme.example:5061",
    "expiration_sec": 600,
    "transport": "TLS",
    "user_agent": "Telnyx-Usage-Voice-Trunk/1.0"
  }
}

Response

Successful response with details about a UAC connection.

Example response

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "uac_connection",
    "active": true,
    "user_name": "myusername123",
    "password": "my123secure456password789",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "anchorsite_override": "Latency",
    "connection_name": "string",
    "sip_uri_calling_preference": "disabled",
    "default_on_hold_comfort_noise_enabled": true,
    "dtmf_type": "RFC 2833",
    "encode_contact_header_enabled": true,
    "encrypted_media": "SRTP",
    "onnet_t38_passthrough_enabled": true,
    "ios_push_credential_id": "ec0c8e5d-439e-4620-a0c1-9d9c8d02a836",
    "android_push_credential_id": "06b09dfd-7154-4980-8b75-cebf7a9d4f8e",
    "webhook_event_url": "https://example.com",
    "webhook_event_failover_url": "https://failover.example.com",
    "webhook_api_version": "1",
    "call_cost_in_webhooks": false,
    "webhook_timeout_secs": 25,
    "tags": [
      "tag1",
      "tag2"
    ],
    "rtcp_settings": {
      "port": "rtp+1",
      "capture_enabled": true,
      "report_frequency_secs": 10
    },
    "inbound": {
      "ani_number_format": "+E.164",
      "dnis_number_format": "+e164",
      "codecs": [
        "G722"
      ],
      "channel_limit": 10,
      "generate_ringback_tone": true,
      "isup_headers_enabled": true,
      "prack_enabled": true,
      "sip_compact_headers_enabled": true,
      "timeout_1xx_secs": 10,
      "timeout_2xx_secs": 15,
      "shaken_stir_enabled": true,
      "simultaneous_ringing": "enabled"
    },
    "outbound": {
      "call_parking_enabled": true,
      "ani_override": "string",
      "ani_override_type": "always",
      "channel_limit": 10,
      "instant_ringback_enabled": true,
      "generate_ringback_tone": true,
      "localization": "string",
      "t38_reinvite_source": "customer",
      "outbound_voice_profile_id": "1293384261075731499"
    },
    "noise_suppression": "both",
    "noise_suppression_details": {
      "engine": "deep_filter_net",
      "attenuation_limit": 80
    },
    "jitter_buffer": {
      "enable_jitter_buffer": true,
      "jitterbuffer_msec_min": 60,
      "jitterbuffer_msec_max": 200
    },
    "authentication": "uac-authentication",
    "registration_status": "Registered",
    "registration_status_updated_at": "2018-02-02T22:25:27.521Z",
    "fqdn": "abc123def456.uac.telnyx.com",
    "fqdns": [
      {
        "id": "1293384261075731499",
        "record_type": "fqdn",
        "connection_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
        "fqdn": "abc123def456.uac.telnyx.com",
        "port": 5060,
        "dns_record_type": "srv",
        "created_at": "2018-02-02T22:25:27.521Z",
        "updated_at": "2018-02-02T22:25:27.521Z"
      }
    ],
    "fqdn_outbound_authentication": "credential-authentication",
    "internal_uac_settings": {
      "destination_uri": "14155550123@acme.sip.telnyx.com"
    },
    "external_uac_settings": {
      "username": "ext8492",
      "password": "testtesttest",
      "proxy": "sip-pbx.acme.example",
      "auth_username": "auth8492",
      "from_user": "8492",
      "outbound_proxy": "outbound.sip-pbx.acme.example:5061",
      "expiration_sec": 600,
      "transport": "TLS",
      "user_agent": "Telnyx-Usage-Voice-Trunk/1.0"
    }
  }
}

Changes

Changed in 4 of the 99 revisions of this API.135

  • 035731b8549a111See the full diff
    • ▲

      the // response property's maxLength was increased from 32 to 256 for the response status

      response-property-max-length-increased

    • ●

      the / request property's maxLength was set to 256

      request-property-max-length-set

    • ○

      the / request property's maxLength was increased from 32 to 256

      request-property-max-length-increased

  • cd8ca79718842See the full diff
    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 4a9f0e65ddd72See the full diff
    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

  • 224ed0d8a5c32See the full diff
    • ●

      removed the request property /

      request-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    This revision also has 111 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 99 revisions, 1 has no diff computed.