From d70585709d12f88af7eef342a59801d606567e03 Mon Sep 17 00:00:00 2001 From: Ivan Sein Date: Thu, 23 Aug 2018 17:10:50 +0200 Subject: [PATCH] Update Signaling documentation. Signed-off-by: Ivan Sein --- docs/api-v1.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/api-v1.md b/docs/api-v1.md index 6f8b576e258..fbb7d8da1d5 100644 --- a/docs/api-v1.md +++ b/docs/api-v1.md @@ -31,6 +31,8 @@ - [Guests](#guests) * [Set display name](#set-display-name) - [Signaling](#signaling) + * [Get signaling settings](#get-signaling-settings) + * [External signaling API](#external-signaling-api) Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` @@ -577,4 +579,23 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1` ## Signaling -See the [Draft](https://github.com/nextcloud/spreed/wiki/Signaling-API) in the wiki… +### Get signaling settings + +* Method: `GET` +* Endpoint: `/signaling/settings` +* Data: + + field | type | Description + ------|------|------------ + `stunservers` | array | STUN servers + `turnservers` | array | TURN servers + `server` | string | URL of the external signaling server + `ticket` | string | Ticket for the external signaling server + +* Response: + - Header: + + `200 OK` + + `404 Not Found` + +### External signaling API +See External Signaling API [Draft](https://github.com/nextcloud/spreed/wiki/Signaling-API) in the wiki…