diff options
| author | Daniel Calviño Sánchez <danxuliu@gmail.com> | 2021-06-02 23:08:49 +0300 |
|---|---|---|
| committer | Daniel Calviño Sánchez <danxuliu@gmail.com> | 2021-06-07 15:19:10 +0300 |
| commit | 7ea382176c4fcf95135557b80a3c2f9632942834 (patch) | |
| tree | ee2073ac4b0aee27ffb4b50b18d4d31142d162f2 /docs | |
| parent | d9331d2d21dcc7fa07abd505c876dcb886d06364 (diff) | |
Add endpoint to update the call flags
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 <danxuliu@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/call.md | 20 |
1 files changed, 20 insertions, 0 deletions
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` |