v55

latestOpenAPI 3.0.3agplraw.githubusercontent.com2026-08-01155431.3 MB

breakout_room

Configure the breakout rooms

post/ocs/v2.php/apps/spreed/api/{apiVersion}/breakout-rooms/{token}

apiVersion'v1' required

tokenstring required

OCS-APIRequestboolean required

Required to be true for the API request to pass

mode0 | 1 | 2 | 3 required

Mode of the breakout rooms

amountinteger required

Number of breakout rooms - Constants {@see BreakoutRoom::MINIMUM_ROOM_AMOUNT} and {@see BreakoutRoom::MAXIMUM_ROOM_AMOUNT}

attendeeMapstring

Mapping of the attendees to breakout rooms

Breakout rooms configured successfully