Skip to main content
GET
JavaScript

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. uac_external_credential is keyed by connection_id; telephony_credential is keyed by username.

Available options:
uac_external_credential,
telephony_credential
connection_id
string

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

username
string

SIP username of the telephony credential to look up. Required when credential_type is 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
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. The populated fields depend on credential_type.