diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/internal-signaling.md | 19 |
1 files changed, 17 insertions, 2 deletions
diff --git a/docs/internal-signaling.md b/docs/internal-signaling.md index 2b3480496..e113498a0 100644 --- a/docs/internal-signaling.md +++ b/docs/internal-signaling.md @@ -2,6 +2,7 @@ * Base endpoint for API v1 is: `/ocs/v2.php/apps/spreed/api/v1` * Base endpoint for API v2 is: `/ocs/v2.php/apps/spreed/api/v2` +* Base endpoint for API v3 is: `/ocs/v2.php/apps/spreed/api/v3` ## Get signaling settings @@ -26,13 +27,13 @@ `turnservers` | array | v1 | TURN servers `sipDialinInfo` | string | v2 | Generic SIP dial-in information for this conversation (admin free text containing the phone number etc) - - STUN server + - STUN server (v1|v2) field | type | Description ---|---|--- `url` | string | STUN server URL - - TURN server + - TURN server (v1|v2) field | type | Description ---|---|--- @@ -41,6 +42,20 @@ `username` | string | User name for the TURN server `credential` | string | User password for the TURN server + - STUN server (v3) + + field | type | Description + ------|------|------------ + `urls` | array | Each element is a STUN server URL as a string + + - TURN server (v3) + + field | type | Description + ------|------|------------ + `urls` | array | Each element is a TURN server URL as a string + `username` | string | User name for the TURN server + `credential` | string | User password for the TURN server + * Response: - Status code: + `200 OK` |