Skip to main content

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.

The SIP Registration Status endpoint exposes the current registration state of a SIP endpoint — whether the endpoint is registered, when it last registered, and the last response Telnyx received from the registrar. A single endpoint serves the three credential types Telnyx supports:
  • uac_third-party_credential — credentials Telnyx uses to register to your PBX (see UAC Connections)
  • telephony_credential — ephemeral SIP credentials issued through the Telephony Credentials API
  • sip_credential_connection — traditional SIP Credential Connections that register to Telnyx
Phase 1 (live today) covers uac_third-party_credential. telephony_credential and sip_credential_connection will be added in upcoming phases without changing the path or request shape.

​
Endpoint

GET https://api.telnyx.com/v2/sip_registration_status

​
Query parameters

ParameterRequiredDescription
credential_typeyesOne of uac_third-party_credential, telephony_credential, sip_credential_connection
connection_idyesIdentifier of the connection or credential to look up
user_idyesOwner of the connection — used to authorize the lookup

​
Authentication

Standard Telnyx v2 Bearer authentication. 
curl -G https://api.telnyx.com/v2/sip_registration_status \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "credential_type=uac_third-party_credential" \
  --data-urlencode "connection_id=2954035328656082602" \
  --data-urlencode "user_id=323"

​
Response

A successful lookup returns the registration state plus the third-party/internal settings that produced it. 
{
  "connection_id": "2954035328656082602",
  "user_id": "323",
  "connection_name": "Office PBX",
  "username": "telnyx-reg",
  "pair_state": "ACTIVE",
  "registered": true,
  "last_registration_response": "200 OK",
  "third-party_uac_settings": {
    "proxy": "sip:pbx.example.com:5060",
    "outbound_proxy": "sip:edge.example.com:5060",
    "transport": "TCP",
    "username": "telnyx-reg",
    "auth_username": "telnyx-reg",
    "from_user": "601",
    "expiration_sec": 3600,
    "password": "***"
  },
  "internal_uac_settings": {
    "destination_uri": "1006@assistant-abc123.sip.telnyx.com"
  }
}

​
Field reference

FieldDescription
pair_stateInternal pairing state (e.g. ACTIVE, INACTIVE)
registeredtrue when the endpoint is currently registered
last_registration_responseSIP response code/text from the last registration attempt (e.g. 200 OK, 401 Unauthorized)
third-party_uac_settingsThe outward-facing SIP settings used for registration (password is always redacted)
internal_uac_settingsThe internal routing target the connection delivers calls to

​
Errors

StatusMeaning
400Missing or invalid query parameters
401Missing/invalid API key
403Connection exists but is not owned by user_id
404No connection or credential matches connection_id