diff options
| author | Daniel Calviño Sánchez <danxuliu@gmail.com> | 2021-05-18 20:04:39 +0300 |
|---|---|---|
| committer | Daniel Calviño Sánchez <danxuliu@gmail.com> | 2021-05-19 19:29:56 +0300 |
| commit | 45c42268190e85a206445164b8986a1f859c9c03 (patch) | |
| tree | 360401f41a712080cca802571a4fc037f873fecc /docs | |
| parent | 2cb9d9625dcd5c2655fa97769d7e69c6697e112c (diff) | |
Remove previous versions for signaling endpoints
The mobile apps will need to adjust to the new version (note that only
the signaling settings endpoint actually changed), but they will not be
compatible with Talk < 12 anyway due to the changes in the conversation
endpoints.
Signed-off-by: Daniel Calviño Sánchez <danxuliu@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/internal-signaling.md | 29 |
1 files changed, 7 insertions, 22 deletions
diff --git a/docs/internal-signaling.md b/docs/internal-signaling.md index e113498a0..8fd1c47c2 100644 --- a/docs/internal-signaling.md +++ b/docs/internal-signaling.md @@ -1,7 +1,7 @@ # Signaling API -* 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 v1 is: 🏁 Removed with API v3 +* Base endpoint for API v2 is: 🏁 Removed with API v3 * Base endpoint for API v3 is: `/ocs/v2.php/apps/spreed/api/v3` ## Get signaling settings @@ -23,33 +23,18 @@ `hideWarning` | string | v1 | Don't show a performance warning although internal signaling is used `server` | string | v1 | URL of the external signaling server `ticket` | string | v1 | Ticket for the external signaling server - `stunservers` | array | v1 | STUN servers - `turnservers` | array | v1 | TURN servers + `stunservers` | array | v3 | STUN servers + `turnservers` | array | v3 | TURN servers `sipDialinInfo` | string | v2 | Generic SIP dial-in information for this conversation (admin free text containing the phone number etc) - - STUN server (v1|v2) + - STUN server field | type | Description - ---|---|--- - `url` | string | STUN server URL - - - TURN server (v1|v2) - - field | type | Description - ---|---|--- - `url` | array | One element array with TURN server URL - `urls` | array | One element array with TURN server URL - `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) - + - TURN server + field | type | Description ------|------|------------ `urls` | array | Each element is a TURN server URL as a string |