Documentation

​
​

Development

User Acquisition

Monetization

Industry

Vivox Unreal SDK

Vivox Unreal SDK

Vivox
​
​
Vivox Unreal SDK
  • Overview
  • Get started
  • Release notes
  • Developer guide
  • Tutorials
  • Reference
    • Vivox Core Unreal class model overview
    • Vivox Unreal conventions
    • Unreal API Reference Manual
    • Access Token Developer Guide
      • Access token terminology
      • Requests that require access tokens
      • Access token identifiers
      • Access token format
        • Access token header
        • Access token payload
        • Access token signature
        • Supported values for the Vivox action claim
      • Access token examples
      • Generate a token on the client
      • Generate a token on a secure server
      • Key update API
      • Access token error codes
    • Server to Server Web API Reference Guide
    • Third-party license information
  1. Vivox Unreal SDK documentation

Supported Values for Vivox Action Claim

Reference supported values for the Vivox action claim in access tokens.
Read time 2 minutes
Last updated 8 months ago
The following table details the Vivox action (vxa) claims in the Vivox SDK.
vxa claimDescriptionVivox 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
Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

    Report a problem with this page