UAC Connections

SIP Registration Status

Changed on

Returns the live SIP registration status for a Telnyx endpoint: whether it is currently registered, when the current registration expires, and the last response Telnyx received from the registrar.

The endpoint supports three credential types, selected with the credential_type query parameter. Each type is keyed by a different identifier:

credential_typeKeyed byUse case
uac_external_credentialconnection_idA UAC (SIP attach) connection that registers to an external PBX.
telephony_credentialusernameAn ephemeral, one-time-use telephony credential.
sip_credential_connectionusernameA traditional SIP credential connection that registers directly to Telnyx.

The authenticated account is taken from your API key; you can only read the registration status of connections and credentials your account owns.

get/sip_registration_status

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/sip_registration_status
  • Auth
    HTTP bearer

Query parameters

credential_type'uac_external_credential' | 'telephony_credential' | 'sip_credential_connection' required

The kind of credential to look up. uac_external_credential is keyed by connection_id; telephony_credential and sip_credential_connection are keyed by username.

connection_idstring

Identifier of the UAC connection to look up. Required when credential_type is uac_external_credential.

usernamestring

SIP username to look up. Required when credential_type is telephony_credential or sip_credential_connection.

Response

Registration status payload

connection_idstring

Identifier of the connection associated with the credential.

connection_namestring

Human-readable connection name.

credential_type'uac_external_credential' | 'telephony_credential' | 'sip_credential_connection'

The credential type that was looked up.

credential_usernamestring

SIP username used for the registration.

registeredboolean

True if the endpoint is currently registered.

sip_registration_status'unregistering' | 'connection_disabled' | 'standby' | 'failed' | 'trying' | 'registered' | 'unknown'

Human-readable registration status derived from the registrar state.

last_registration_responsestring nullable

SIP response from the last registration attempt.

Example response

{
  "last_registration_response": "200 OK"
}

Changes

  • a72569d69430Revision changes
    • breaking

      the response property became nullable for the status

    • warning

      added the new sip_credential_connection enum value to the response property for the response status

    • warning

      added the new telephony_credential enum value to the response property for the response status

    • info

      added the new optional query request parameter username

    • info

      the query request parameter connection_id became optional

    • info

      added the new enum value sip_credential_connection to the query request parameter credential_type

    • info

      added the new enum value telephony_credential to the query request parameter credential_type

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 3390803c3bb0Revision changes
    • warning

      removed the optional property / from the response with the status

    • info

      api tag UAC Connections added

    • info

      api tag SIP Registration Status removed

    • info

      added the optional property / to the response with the status