Sign in
UAC Connections

SIP Registration Status

Returns the live SIP registration state of a UAC connection: whether it is currently registered, when it last registered, and the last response Telnyx received from the registrar. Only uac_external_credential is supported today.

get/sip_registration_status

Query parameters

credential_type'uac_external_credential' required

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

connection_idstring required

Identifier of the UAC connection to look up.

Response

Registration status payload

connection_idstring

Identifier of the UAC connection.

connection_namestring

Human-readable connection name.

credential_type'uac_external_credential'

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

SIP response from the last registration attempt.

Example response

{
  "last_registration_response": "200 OK"
}

Changes

Changed in 5 of the 47 revisions of this API.21011

  • 3390803c3bb013See the full diff
    • ●

      removed the optional property sip_registration_details/sipUriUserHost from the response with the 200 status

      response-optional-property-removed

    • ○

      api tag UAC Connections added

      api-tag-added

    • ○

      api tag SIP Registration Status removed

      api-tag-removed

    • ○

      added the optional property sip_registration_details/sip_uri_user_host to the response with the 200 status

      response-optional-property-added

  • a46ce382e6e283See the full diff
    • ●

      removed the optional property b2bua_external from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property b2bua_internal from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property external_state from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property external_uac_settings from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property internal_uac_settings from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property pair_state from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property user_id from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property username from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property credential_username to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property sip_registration_details to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property sip_registration_status to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3477b848e7561See the full diff
    • ●

      deleted the query request parameter user_id

      request-parameter-removed

  • 2b3a20efe79624See the full diff
    • ▲

      removed the enum value sip_credential_connection from the query request parameter credential_type

      request-parameter-enum-value-removed

    • ▲

      removed the enum value telephony_credential from the query request parameter credential_type

      request-parameter-enum-value-removed

    • ○

      added the optional property b2bua_external to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property b2bua_internal to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property credential_type to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property external_state to the response with the 200 status

      response-optional-property-added

  • 9958429375f51See the full diff
    • ○

      endpoint added

      endpoint-added