Skip to main content
GET
/
sip_registration_status
JavaScript
import Telnyx from 'telnyx';

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

const sipRegistrationStatus = await client.sipRegistrationStatus.retrieve({
  connection_id: 'connection_id',
  credential_type: 'uac_external_credential',
  user_id: 'user_id',
});

console.log(sipRegistrationStatus.connection_id);
{
  "connection_id": "<string>",
  "user_id": "<string>",
  "connection_name": "<string>",
  "username": "<string>",
  "pair_state": "ACTIVE",
  "external_state": "REGED",
  "registered": true,
  "last_registration_response": "200 OK",
  "external_uac_settings": {
    "proxy": "<string>",
    "outbound_proxy": "<string>",
    "username": "<string>",
    "auth_username": "<string>",
    "from_user": "<string>",
    "expiration_sec": 123,
    "password": "***"
  },
  "internal_uac_settings": {
    "destination_uri": "<string>"
  },
  "b2bua_external": {},
  "b2bua_internal": {}
}

Documentation Index

Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Query Parameters

credential_type
enum<string>
required

The kind of credential to look up. Only uac_external_credential is supported today.

Available options:
uac_external_credential
connection_id
string
required

Identifier of the UAC connection to look up.

user_id
string
required

Owner of the connection. Used to authorize the lookup.

Response

Registration status payload

credential_type
enum<string>

The credential type that was looked up.

Available options:
uac_external_credential
connection_id
string

Identifier of the UAC connection.

user_id
string

Owner of the connection.

connection_name
string

Human-readable connection name.

username
string

SIP username used for the registration.

pair_state
string

Internal pairing state, e.g. ACTIVE or INACTIVE.

Example:

"ACTIVE"

external_state
string

Registration state on the external (UAC / PBX) side, e.g. REGED.

Example:

"REGED"

registered
boolean

True if the endpoint is currently registered.

last_registration_response
string

SIP response from the last registration attempt.

Example:

"200 OK"

external_uac_settings
object

Outward-facing SIP settings used for registration. Password is redacted.

internal_uac_settings
object

Internal routing target the connection delivers calls to.

b2bua_external
object

Raw external-side registration block reported by the registrar.

b2bua_internal
object

Raw internal-side block reported by the registrar.