diff options
| author | Joas Schilling <coding@schilljs.com> | 2019-07-05 18:01:54 +0300 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2019-07-05 18:01:54 +0300 |
| commit | 09255e8beae5a59f06cd4522cbd5a6ec4d80c54b (patch) | |
| tree | 144e1561d61a767cf148bee7bc59ce8c5b76d19e /docs/call.md | |
| parent | 4e65251fa3caa4d797a0cf7cfa3af648aa264952 (diff) | |
Start converting to readthedocs
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs/call.md')
| -rw-r--r-- | docs/call.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/call.md b/docs/call.md new file mode 100644 index 000000000..7c1dae4e6 --- /dev/null +++ b/docs/call.md @@ -0,0 +1,42 @@ +# Call API + +Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` + +## Get list of connected participants + +* Method: `GET` +* Endpoint: `/call/{token}` + +* Response: + - Header: + + `200 OK` + + `404 Not Found` When the conversation could not be found for the participant + + - Data: + Array of participants, each participant has at least: + + field | type | Description + ------|------|------------ + `userId` | string | Is empty for guests + `lastPing` | int | Timestamp of the last ping of the user (should be used for sorting) + `sessionId` | string | 512 character long string + +## Join a call + +* Method: `POST` +* Endpoint: `/call/{token}` + +* Response: + - Header: + + `200 OK` + + `404 Not Found` When the conversation could not be found for the participant + +## Leave a call (but staying in the conversation for future calls and chat) + +* Method: `DELETE` +* Endpoint: `/call/{token}` + +* Response: + - Header: + + `200 OK` + + `404 Not Found` When the conversation could not be found for the participant |