Retrieve a UAC connection

Retrieves the details of an existing UAC connection.

GET /uac_connections/{id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const uacConnection = await client.uacConnections.retrieve('id');

console.log(uacConnection.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
uac_connection = client.uac_connections.retrieve(
    "id",
)
print(uac_connection.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	uacConnection, err := client.UacConnections.Get(context.TODO(), "id")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", uacConnection.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.uacconnections.UacConnectionRetrieveParams;
import com.telnyx.sdk.models.uacconnections.UacConnectionRetrieveResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        UacConnectionRetrieveResponse uacConnection = client.uacConnections().retrieve("id");
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

uac_connection = telnyx.uac_connections.retrieve("id")

puts(uac_connection)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $uacConnection = $client->uacConnections->retrieve('id');

  var_dump($uacConnection);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx uac-connections retrieve \
  --api-key 'My API Key' \
  --id id

curl --request GET \
  --url https://api.telnyx.com/v2/uac_connections/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "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": "[e-mail]"
    },
    "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"
    }
  }
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Bad Request",
      "detail": "The request failed because it was not well-formed.",
      "source": {
        "pointer": "/"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10009",
      "title": "Authentication failed",
      "detail": "Could not understand the provided credentials.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10009"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10010",
      "title": "Not authorized",
      "detail": "You are not authorized to access the requested resource.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10010"
      },
      "source": {
        "pointer": "/"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10005",
      "title": "Resource not found",
      "detail": "The requested resource or URL could not be found.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10005"
      },
      "source": {
        "pointer": "/"
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Identifies the resource.

Response

200

application/json

Successful response with details about a UAC connection.

data · UAC Connection · 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 PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the registration.

Show child attributes

Example:

{
  "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": "[e-mail]"
  },
  "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"
  }
}