WAwavix
Wavix Embeddable

Create a widget token

Changed on

Creates a Wavix Embeddable widget token that authenticates a browser-based softphone session. The token expires after ttl seconds.

post/v2/webrtc/tokens

Request

  • Base URL
    https://api.wavix.com
  • URL
    https://api.wavix.com/v2/webrtc/tokens
  • Auth
    HTTP bearer

Request body

sip_trunkstring required

Name of the SIP trunk the token authenticates against.

payloadobject nullable

Arbitrary client-defined data to associate with the token.

ttlinteger nullable

Time to live in seconds. Default 3600; null means no expiration.

Example request

{
  "sip_trunk": "my-sip-trunk",
  "payload": {},
  "ttl": 3600
}

Response

Returns the created widget token.

tokenstring required

Signed JWT used by the Wavix embeddable widget to authenticate.

uuidstring required

Unique identifier of the WebRTC token.

sip_trunkstring required

Name of the SIP trunk the token authenticates against.

payloadobject nullable

Arbitrary client-defined data associated with the token.

ttlinteger nullable

Lifetime of the token, in seconds. null means the token does not expire.

Example response

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "sip_trunk": "my-sip-trunk",
  "payload": {},
  "ttl": 3600
}

Changes