diff options
author | Joas Schilling <coding@schilljs.com> | 2017-09-21 11:16:38 +0200 |
---|---|---|
committer | Joas Schilling <coding@schilljs.com> | 2017-09-22 16:16:04 +0200 |
commit | 6117e5ae8d98b9c92c260a7aab41f26825371d4d (patch) | |
tree | d124afb09bd1b5ee3a69a62c78ffdc14f7c443be /docs | |
parent | 1eb766eb01d8bc8b4a6e11ef5d7cf59cf235c306 (diff) |
Doc paassword on "join call"
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/api-v1.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/api-v1.md b/docs/api-v1.md index ffa35ce0c..dbc943f91 100644 --- a/docs/api-v1.md +++ b/docs/api-v1.md @@ -313,10 +313,16 @@ 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: |