Skip to main content
GET
SIP Registration Status

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>
default:sip_credential_connection
required

Credential type supported by this playground.

Available options:
sip_credential_connection,
telephony_credential
username
string
required

SIP username of the connection or telephony credential.

Response

Registration status payload

connection_id
string

Identifier of the connection associated with the credential.

connection_name
string

Human-readable connection name.

credential_type
enum<string>

The credential type that was looked up.

Available options:
uac_external_credential,
telephony_credential,
sip_credential_connection
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 | null

SIP response from the last registration attempt.

Example:

"200 OK"

sip_registration_details
object

Detailed registration information reported by the registrar. The populated fields depend on credential_type: UAC external credentials report auth_retries, uptime, next_action_at, failures, and sip_uri_user_host; telephony credentials and SIP credential connections report ua_ip, ua_port, transport, and last_modified. All types report expires, but its unit differs by credential_type — see that field.