Documentation

​
​

Development

User Acquisition

Monetization

Industry

Vivox Core SDK

Vivox Core SDK

Vivox
​
​
Vivox Core SDK
  • Overview
  • Before you begin
  • Get started
  • Release notes
  • Developer Guide
    • Client SDK basics
    • Channels
      • Channel name criteria
      • Channel types
      • Echo channels
      • Positional channels
      • Volume differences
      • Channel identifiers for large scale games
      • Participant events
      • Channel webhooks
      • Join a channel
        • Request capture device access
        • Initiate a channel join
      • Leave a channel
      • Kick a user from a channel
      • Manage session groups
      • Audio injection
      • Methods for setting audio levels
      • Derumbler
      • Automatic connection recovery
    • Presence management
    • Messaging
    • Manage audio
    • Couch co-op
    • Android app development
    • iOS app development
    • macOS app development
    • Windows app development
    • Real-time recording
    • Speech-to-text audio transcription
    • Text-to-speech
    • Troubleshooting
  • Reference
  • Privacy overview
  1. Vivox Core SDK documentation

Join a channel

Follow this workflow to join a Vivox channel and enable voice or text communication.
Read time 1 minute
Last updated 8 months ago
To join a channel, the game uses the 
vx_req_sessiongroup_add_session
message and the channel URI that is generated by the game that maps to an audio element in the game.
Note
Developers must ensure that their game checks the permissions for the capture device at runtime before it join a Vivox voice channel on desktop or mobile.
Joining a channel requires an access token.
For more information, refer to the Access Token Developer Guide.
The game can choose to join a channel with audio capability, which enables the player to participate in group audio. The game can also choose to join a channel with text capability, which enables the player to participate in group text.
Note
A user can join a maximum of 10 non-positional channels at a time. Attempts to join a channel beyond that limit fail with a 
VxXmppServerErrorServiceUnavailable (20502)
error.
Note
Channels have a maximum occupancy of 200 participants. Attempts to join a channel that has reached 200 participants will fail with a 
VxXmppServerErrorServiceUnavailable (20502)
error.
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