From 7ea382176c4fcf95135557b80a3c2f9632942834 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Calvi=C3=B1o=20S=C3=A1nchez?= Date: Wed, 2 Jun 2021 22:08:49 +0200 Subject: Add endpoint to update the call flags MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The call flags are updated when joining and leaving a call. However, during a call the audio and video devices can be disabled without needing a reconnection, so an endpoint to just update the call flags is also needed. Signed-off-by: Daniel Calviño Sánchez --- docs/call.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'docs') diff --git a/docs/call.md b/docs/call.md index fb44d17cc..fba81dfe8 100644 --- a/docs/call.md +++ b/docs/call.md @@ -47,6 +47,26 @@ + `404 Not Found` When the user did not join the conversation before + `412 Precondition Failed` When the lobby is active and the user is not a moderator +## Update call flags + +* Method: `PUT` +* Endpoint: `/call/{token}` +* Data: + + field | type | Description + ---|---|--- + `flags` | int | Flags what streams are provided by the participant (see [Constants - Participant in-call flag](constants.md#participant-in-call-flag)) + +* Response: + - Status code: + + `200 OK` + + `400 Bad Request` When the user is not in the call + + `400 Bad Request` When the flags do not contain "in call" + + `403 Forbidden` When the conversation is read-only + + `404 Not Found` When the conversation could not be found for the participant + + `404 Not Found` When the user did not join the conversation before + + `412 Precondition Failed` When the lobby is active and the user is not a moderator + ## Leave a call (but staying in the conversation for future calls and chat) * Method: `DELETE` -- cgit v1.2.3