Skip to navigation
API OverviewBrowser calling

Get a client token

View as Markdown

Get a client token, including whether a client is currently connected with it (registered) and when it last was (last_used_at). The secret is never returned.

Authentication

AuthorizationBearer

Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See Authentication for details.

Path parameters

client_token_idstringRequiredformat: "^ct_[0-9a-f]{32}$"
Client token identifier.

Response headers

traceparentstringOptionalformat: "^00-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$"=55 characters

Server-owned W3C Trace Context for correlating this response with support and observability data. It is present on successful and error responses. When a request has a valid traceparent, the server links the incoming context to its own trace and returns that trace identifier.

Response

The token.
client_token_idstring
Token identifier. It is also the SIP username.
created_atdatetime
When the token was created.
expires_atdatetime
When the token stops authenticating new connections.
identitystring
Identity the token authenticates.
last_used_atdatetime or null

When a client last connected with this token, or null if none has.

registeredboolean
True while a client is connected with this token.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
406
Not Acceptable Error
500
Internal Server Error
503
Service Unavailable Error