Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Supported Values for Vivox Action Claim

Reference supported values for the Vivox action claim in access tokens.

Read time 1 minute

Last updated 2 days ago

The following table details the Vivox action (vxa) claims in the Vivox SDK.

vxa claim	Description	Vivox SDK requests and Server APIs
join	Channel join.	vx_req_sessiongroup_add_session vx_req_session_create `https://.../api2/viv_multi_chan_cmd.php?mode=add`
join_muted	Channel join listen-only and moderator muted.	vx_req_sessiongroup_add_session vx_req_session_create `https://.../api2/viv_multi_chan_cmd.php?mode=add`
kick	Kick user from a channel.	vx_req_channel_kick_user `https://.../api2/viv_chan_cmd.php?mode=kick` `https://.../api2/viv_chan_cmd.php?mode=drop_all`
login	Sign in.	vx_req_account_anonymous_login `https://.../api2/viv_signin.php`
mute	Mute or unmute a user in a channel.	vx_req_channel_mute_user `https://.../api2/viv_chan_cmd.php?mode=mute` `https://.../api2/viv_chan_cmd.php?mode=unmute` vx_req_channel_mute_all_users `https://.../api2/viv_chan_cmd.php?mode=mute_all` `https://.../api2/viv_chan_cmd.php?mode=unmute_all`
trxn	Enable or disable speech-to-text transcription. If the Vivox domain that you are using is not enabled for speech-to-text transcription, attempting to enable transcription results in an error.	vx_req_session_transcription_control