Vivox: What are the payload claims for a Vivox Access Token (VAT)?

The payload for a Vivox Access Token (VAT) is a base64url-encoded JSON object that contains the claims asserted by the token. The following list details the possible claims that can be used in a token.

Note: Not all tokens use all of these claims.

For more information about the parameters that are required for each token, see Where can I find the Vivox Access Token (VAT) generation code?

iss

This is the application-specific issuer. When you create an application on the Vivox Developer Portal, the issuer is provided.

Example: melon1321-te07-dev

exp

Expiration time as epoch seconds. This value is usually the current time plus 90 seconds.

Example: 1451606400

vxa

Action (join, join_muted, kick, login, mute, trxn).

Example: join

vxi

Used to guarantee token uniqueness. If all other claims are identical, this must be different or the token could be rejected as already used. Vivox recommends using an unsigned integer that is increased by 1 for every token generated.

Example: 1

sub

Subject. A user SIP URI that is used for mute and kick actions. This is the user who will be muted/unmuted or kicked.

Example: sip:.melon1321-te07-dev.jerky.@vdx5.vivox.com

f

From. A user SIP URI that is used in all actions. This is the user who performs actions such as signing in, joining the channel, and muting another user.

Example: sip:.melon1321-te07-dev.beef.@vdx5.vivox.com

t

To. A channel SIP URI that is used in join, mute, kick, and transcription actions. This is the channel where the action takes place.

Example: sip:confctl-g-melon1321-te07-dev.tasty@vdx5.vivox.com