diff options
| author | Joas Schilling <coding@schilljs.com> | 2022-12-07 14:55:48 +0100 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2022-12-12 12:08:24 +0100 |
| commit | d390d3bec3b0efddf580a4e45c527430b1c4c830 (patch) | |
| tree | 8535347d3f0f46cadf76119d99c017f60cdf2abc /docs | |
| parent | a0d6794ebe12949dd32c55decaf2997cbf7c74ae (diff) | |
Allow to "Request assistance" and reset it
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/breakout-rooms.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/breakout-rooms.md b/docs/breakout-rooms.md index 8bd689cd8..58cf124fb 100644 --- a/docs/breakout-rooms.md +++ b/docs/breakout-rooms.md @@ -93,3 +93,27 @@ Group and public conversations can be used to host breakout rooms. + `403 Forbidden` When the participant is not a moderator + `404 Not Found` When the conversation could not be found for the participant + `413 Payload Too Large` When the message was longer than the allowed limit of 32000 characters (check the `spreed => config => chat => max-length` capability for the limit) + +## Request assistance + +This endpoint allows participants to raise their hand (token is the breakout room) and moderators will see it in any of the breakout rooms as well as the parent room. + +* Required capability: `breakout-rooms-v1` +* Method: `POST` +* Endpoint: `/breakout-rooms/{token}/request-assistance` +* Response: + - Status code: + + `200 OK` + + `400 Bad Request` When the room is not a breakout room or breakout rooms are not started + + `404 Not Found` When the conversation could not be found for the participant + +## Reset request for assistance + +* Required capability: `breakout-rooms-v1` +* Method: `DELETE` +* Endpoint: `/breakout-rooms/{token}/request-assistance` +* Response: + - Status code: + + `200 OK` + + `400 Bad Request` When the room does not have breakout rooms configured + + `404 Not Found` When the conversation could not be found for the participant |