diff options
| author | Joas Schilling <coding@schilljs.com> | 2017-10-26 16:10:58 +0200 |
|---|---|---|
| committer | Ivan Sein <ivan@struktur.de> | 2017-11-03 13:04:52 +0100 |
| commit | eae71a3977068b578c590982c3b9ebacf9f23074 (patch) | |
| tree | 3afa99773cd4cf27234d7da25a13c11072afb66b /docs | |
| parent | d83c3d250eb249f3308b7fc7925272ddf756e8ef (diff) | |
Split joining a room and joining a call API wise
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api-v1.md | 46 |
1 files changed, 33 insertions, 13 deletions
diff --git a/docs/api-v1.md b/docs/api-v1.md index 43f3ff295..d60355d08 100644 --- a/docs/api-v1.md +++ b/docs/api-v1.md @@ -283,6 +283,38 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` + `200 OK` + `404 Not Found` When the room could not be found for the participant +### Join a room (available for call and chat) + +* Method: `POST` +* Endpoint: `/room/{token}/participants/active` +* Data: + + field | type | Description + ------|------|------------ + `password` | string | Optional: Password is only required for users which are of type `4` or `5` and only when the room has `hasPassword` set to true. + +* Response: + - Header: + + `200 OK` + + `403 Forbidden` When the password is required and didn't match + + `404 Not Found` When the room could not be found for the participant + + - Data: + + field | type | Description + ------|------|------------ + `sessionId` | string | 512 character long string + +### Leave a room (not available for call and chat anymore) + +* Method: `DELETE` +* Endpoint: `/room/{token}/participants/active` + +* Response: + - Header: + + `200 OK` + + `404 Not Found` When the room could not be found for the participant + ### Promote a user to a moderator * Method: `POST` @@ -347,24 +379,12 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` * Method: `POST` * Endpoint: `/call/{token}` -* Data: - - field | type | Description - ------|------|------------ - `password` | string | Optional: Password is only required for users which are of type `4` or `5` and only when the room has `hasPassword` set to true. * Response: - Header: + `200 OK` - + `403 Forbidden` When the password is required and didn't match + `404 Not Found` When the room could not be found for the participant - - Data: - - field | type | Description - ------|------|------------ - `sessionId` | string | 512 character long string - ### Send ping to keep the call alive * Method: `POST` @@ -375,7 +395,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` + `200 OK` + `404 Not Found` When the room could not be found for the participant -### Leave a call (but staying in the room for future calls) +### Leave a call (but staying in the room for future calls and chat) * Method: `DELETE` * Endpoint: `/call/{token}` |