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 examples
        • Example: Login token
        • Example: Join token
        • Example: Join_Muted token
        • Example: Kick tokens
        • Example: Drop_All token
        • Example: Mute tokens
        • Example: Mute_All token
        • Example: Transcription token
      • 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

Example: Drop all token

Examples of Mute tokens that allow muting individual users in a channel.
Read time 1 minute
Last updated 8 months ago

The token in this example allows the user "blindmelon-AppName-dev-Admin" to drop all users from the channel "testchannel".
The token expiration time is September 17, 2020 at 1:30 PM UTC.
The token signing key is "secret!" (not including quotes).
Note
Because this is a kick command, the vxa is "kick".
Header
{}
Payload
Note
Spacing has been added to this code for demonstration purposes. You can also list claims in any order.
{ "vxi":729614, "f":"sip:blindmelon-AppName-dev-Admin@tla.vivox.com", "iss":"blindmelon-AppName-dev", "vxa":"kick", "t":"sip:confctl-g-blindmelon-AppName-dev.testchannel@tla.vivox.com", "exp":1600349400}
Access token
e30.eyJ2eGkiOjcyOTYxNCwiZiI6InNpcDpibGluZG1lbG9uLUFwcE5hbWUtZGV2LUFkbWluQHRsYS52aXZveC5jb20iLCJpc3MiOiJibGluZG1lbG9uLUFwcE5hbWUtZGV2IiwidnhhIjoia2ljayIsInQiOiJzaXA6Y29uZmN0bC1nLWJsaW5kbWVsb24tQXBwTmFtZS1kZXYudGVzdGNoYW5uZWxAdGxhLnZpdm94LmNvbSIsImV4cCI6MTYwMDM0OTQwMH0.bvNDTcXIHRpckAiFzy3wPiwgYGks4E9_WuEA5HMGpGE

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.

  • On this page
    • Header

    • Payload

    • Access token


Report a problem with this page