Skip to content

Commit

Permalink
Update Signaling documentation.
Browse files Browse the repository at this point in the history
Signed-off-by: Ivan Sein <[email protected]>
  • Loading branch information
Ivansss committed Aug 23, 2018
1 parent f8d6940 commit d705857
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion docs/api-v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down Expand Up @@ -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…

0 comments on commit d705857

Please sign in to comment.