NEnextcloud
breakout_room

Configure the breakout rooms

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

Request

  • The document declares no server URL.
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

apiVersion'v1' required
tokenstring required

Headers

OCS-APIRequestboolean required

Required to be true for the API request to pass

Request body

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

Response

Breakout rooms configured successfully

Changes

  • 7e78681bf716Revision changes
    • info

      added the required property /// to the response with the status

  • dc2b6567a07bRevision changes
    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status