Skip to main content
GET
Retrieve a widget token

Authorizations

Authorization
string
header
required

Wavix API key. Pass as Authorization: Bearer <api_key>. Keys support per-resource scopes (none / read / write). See Restricted keys and scopes.

Path Parameters

id
string<uuid>
required

The UUID of the widget token to retrieve.

Response

Returns the widget token.

Represents a WebRTC token that authorizes the Wavix embeddable widget to register against a SIP trunk.

uuid
string
required

Unique identifier of the WebRTC token.

Example:

"550e8400-e29b-41d4-a716-446655440000"

sip_trunk
string
required

Name of the SIP trunk the token authenticates against.

Example:

"my-sip-trunk"

payload
object | null

Arbitrary client-defined data associated with the token.

Example:
ttl
integer | null

Time to live, in seconds. null means no expiration.

Required range: x >= 1
Example:

3600