diff options
| author | Daniel Calviño Sánchez <danxuliu@gmail.com> | 2021-05-06 22:04:54 +0300 |
|---|---|---|
| committer | Joas Schilling <coding@schilljs.com> | 2021-05-19 16:24:40 +0300 |
| commit | 3c8418e69e639021836b6373a7db2538cd3b682c (patch) | |
| tree | f4af7ce2a692bc56ba2d4e8017ec8e05c2279a88 /docs | |
| parent | f8215200956f422091247d599e3fba7b2356c162 (diff) | |
Unify STUN and TURN server URLs
The "stunservers" parameter was a list of several elements each one with
a "url" parameter, which was a string. Now the "stunservers" parameter
is a list of several elements (although in practice there will be just
one) each one with a "urls" parameter, which is a list of strings.
The "turnservers" parameter was a list of several elements each one with
a "url" parameter and a "urls" parameter, which were both a list of a
single string. Now the "turnservers" parameter is a list of several
elements each one with a "urls" parameter, which is a list of strings.
Each element of "turnservers" contain too "username" and "credential"
parameters that apply to all the elements in the "urls" parameter.
The format resembles the RTCIceServer format, so the returned values can
be directly used by the WebUI like done until now. Mobile clients will
need to be adjusted, though.
Signed-off-by: Daniel Calviño Sánchez <danxuliu@gmail.com>
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` |