Browse Source
Update call documentation with recent changes
Signed-off-by: Joas Schilling <coding@schilljs.com>
pull/2290/head
Joas Schilling
6 years ago
No known key found for this signature in database
GPG Key ID: 7076EA9751AACDDA
2 changed files with
19 additions and
0 deletions
-
docs/call.md
-
docs/constants.md
|
|
|
@ -10,7 +10,9 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` |
|
|
|
* Response: |
|
|
|
- Header: |
|
|
|
+ `200 OK` |
|
|
|
+ `403 Forbidden` When the conversation is read-only |
|
|
|
+ `404 Not Found` When the conversation could not be found for the participant |
|
|
|
+ `412 Precondition Failed` When the lobby is active and the user is not a moderator |
|
|
|
|
|
|
|
- Data: |
|
|
|
Array of participants, each participant has at least: |
|
|
|
@ -25,11 +27,19 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` |
|
|
|
|
|
|
|
* Method: `POST` |
|
|
|
* 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: |
|
|
|
- Header: |
|
|
|
+ `200 OK` |
|
|
|
+ `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) |
|
|
|
|
|
|
|
@ -39,4 +49,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` |
|
|
|
* Response: |
|
|
|
- Header: |
|
|
|
+ `200 OK` |
|
|
|
+ `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 |
|
|
|
@ -20,6 +20,12 @@ title: Constants |
|
|
|
* `5` user following a public link |
|
|
|
* `6` guest with moderator permissions |
|
|
|
|
|
|
|
## Participant in-call flag |
|
|
|
* `0` disconnected |
|
|
|
* `1` in-call |
|
|
|
* `2` provides audio |
|
|
|
* `4` provides video |
|
|
|
|
|
|
|
## Actor types of chat messages |
|
|
|
* `guests` - guest users |
|
|
|
* `users` - logged-in users |
|
|
|
|
