v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
UAC Connections

Retrieve a UAC connection

Retrieves the details of an existing UAC connection.

get/uac_connections/{id}

Path parameters

idstring required

Identifies the resource.

Response

Successful response with details about a UAC connection.

Example response

{
  "data": {
    "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
  }
}