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',
});

console.log(sipRegistrationStatus.connection_id);
{
  "connection_id": "1234567890",
  "connection_name": "FreePBX UAC 1002",
  "credential_type": "uac_external_credential",
  "credential_username": "useralice12345",
  "registered": true,
  "sip_registration_status": "registered",
  "last_registration_response": "200 OK",
  "sip_registration_details": {
    "auth_retries": 0,
    "expires": 1780404431,
    "uptime": 1780401551699908,
    "next_action_at": 1780414482,
    "failures": 0,
    "sip_uri_user_host": "1002@192.0.2.10"
  }
}

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.

Response

Registration status payload

​
connection_id
string

Identifier of the UAC connection.

​
connection_name
string

Human-readable connection name.

​
credential_type
enum<string>

The credential type that was looked up.

Available options:
uac_external_credential
​
credential_username
string

SIP username used for the registration.

​
registered
boolean

True if the endpoint is currently registered.

​
sip_registration_status
enum<string>

Human-readable registration status derived from the registrar state.

Available options:
unregistering,
connection_disabled,
standby,
failed,
trying,
registered,
unknown
​
last_registration_response
string

SIP response from the last registration attempt.

Example:

"200 OK"

​
sip_registration_details
object

Detailed registration information reported by the registrar.