POST
/
v2
/
webrtc
/
tokens
Create a widget token
curl --request POST \
  --url https://api.wavix.com/v2/webrtc/tokens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sip_trunk": "my-sip-trunk",
  "ttl": 3600,
  "payload": {
    "user_id": "42"
  }
}
'
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "uuid": "uuid",
  "sip_trunk": "sip trunk",
  "payload": {},
  "ttl": 123
}

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.

Body

application/json

Attributes for the new widget token.

​
sip_trunk
string
required

Name of the SIP trunk the token authenticates against.

Example:

"my-sip-trunk"

​
payload
object

Arbitrary client-defined data to associate with the token.

Example:
{}
​
ttl
integer | null
default:3600

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

Required range: x >= 1
Example:

3600

Response

Returns the created widget token.

​
token
string
required

Signed JWT used by the Wavix embeddable widget to authenticate.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

​
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

Arbitrary client-defined data associated with the token.

Example:
{}
​
ttl
integer | null

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

Example:

3600