Documentation

Payload

Properties

Exp

  • exp: number

The expiration time as epoch seconds.

This value is usally the current time plus 90 seconds.

e.g. 1600349400

memberof

Payload

F

  • f: string

From.

This is a user SIP URI that is used in all actions.

This is the user who performs actions such as signing in, joining the channel, or muting another user.

e.g. sip:.blindmelon-AppName-dev.beef.@tla.vivox.com

memberof

Payload

Iss

  • iss: string

An application-specific issuer.

The issuer is provided when you create an aplication on the Vivox Developer portal.

e.g. blindmelon-AppName-dev

memberof

Payload

Optional Sub

  • sub: string

The subject.

A user SIP URI that is used for mute and kick actions.

This is the user who is muted or unmuted, or the user who is kicked.

e.g. sip:.blindmelon-AppName-dev.jerky.@tla.vivox.com

memberof

Payload

T

  • t: string

To.

This is a channel SIP URI that is used in join, mute, kick, and transcription actions.

This is the channel where the action takes place.

e.g. sip:confctl-g-blindmelon-AppName-dev.testchannel@tla.vivox.com

memberof

Payload

Vxa

  • vxa: string

A Vivox action.

For more information see Supported values for the Vivox action claim.

e.g. join, join_muted, kick, login, mute

memberof

Payload

Optional Vxi

  • vxi: number

Guarantee token uniqueness.

If all other claims are identical, this must be different or the token could be rejected as already used.

Note: We recommend that you use an unsigned integer that is increased by 1 for every token that is generated.

e.g. 1

memberof

Payload