summaryrefslogtreecommitdiffstats
path: root/docs/api-v1.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api-v1.md')
-rw-r--r--docs/api-v1.md6
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: