Zoom Apps for Breakout Rooms

What are breakout rooms?

Breakout rooms allow the host to split a meeting into smaller sessions to enable close collaboration or networking in smaller groups.

For more details, see our blog post on using breakout rooms and support article on managing breakout rooms.

Handling breakout rooms in Zoom Apps

  • All apps that work in meetings are required to support breakout rooms. The default expectation is that the application treats breakout rooms as separate meetings, and engages only participants in the current room.

  • Developers can choose to implement different logic for their apps in a breakout room environment to create more immersive experiences.

Special considerations for apps in breakout rooms

  • When the application is used in a breakout room, the invites can be sent only to participants in the same breakout room.

  • To identify that the application is running in a breakout room, call getMeetingUUID method: in breakout room environment, it returns meetingUUID and parentUUID, where meetingUUID identifies the current breakout room, and parentUUID identifies the main meeting. If the application needs to create a multi-room experience, use parentUUID to connect individual rooms.

  • Applications need to work reliably without a meeting owner. One meeting supports a large number of breakout rooms, and all of them have the same meeting owner who is not necessarily present in an individual room.

  • When the user enters or leaves the breakout room, the application is not reloaded but receives onBreakoutRoomChange events. It is recommended to reevaluate the meeting context (meetingUUID, current participants) when this event is triggered.

  • When the user enters or leaves the breakout room, the participant id changes in all methods.

  • When an app is started inside of a breakout room, the X-Zoom-App-Context header contains the Breakout Room UUID in the mid field, and the main Meeting UUID in the pid field.

Managing breakout rooms through Zoom Apps SDK

Applications can have an additional level of control over Zoom Meetings and facilitate new meeting experiences by creating and managing breakout room configurations.

  • To create a fully automated experience, the application must be used by a meeting owner. This enables the application to create rooms, assign participants and open/close the rooms.
  • When an application is used by a participant, it can allow participants to switch between breakout rooms, or join the main meeting.

When the application is in use, the host maintains manual control over the state. Use event onMeetingConfigChanged to catch any changes, and getBreakoutRoomList to get the up-to-date configuration.

When implementing breakout room management, consider graceful handling of edge case scenarios:

  • Outdated Zoom clients that don't have support for the required Zoom Apps SDK.
  • Meetings that don't have breakout rooms enabled.

Note: Currently breakout rooms do not support Collaborate or Layers.

Enabling breakout rooms using REST API

You can enable or disabled breakout rooms on account, group and user level. Each level has lock down option that prevents lower levels from changing the setting.

To help users configure breakout rooms automatically, you can implement the following logic:

  1. Enable breakout rooms for hosts at a user level; do not change the settings for all application users. The recommended best practice is to ask the host’s confirmation before altering the setting.
  2. Validate the setting was set sucessfully.
  3. When settings are not set successfully, direct users to documentation or implement an account-level helper application to update global settings.

REST API method (look for in_meeting.breakout_room setting):

Need help?

If you're looking for help, try Developer Support or our Developer Forum. Priority support is also available with Premier Developer Support plans.