blob: e113498a0ee799c3b1b1f3fbc7667aad02387feb (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
# 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 v3 is: `/ocs/v2.php/apps/spreed/api/v3`
## Get signaling settings
* Method: `GET`
* Endpoint: `/signaling/settings`
* Data:
field | type | Description
---|---|---
`token` | string | The conversation to get the signaling settings for
* Response:
field | type | Added | Description
---|---|---|---
`signalingMode` | string | v1 | See [Signaling modes](constants.md#Signaling_modes)
`userId` | string | v1 | Current user id
`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
`sipDialinInfo` | string | v2 | Generic SIP dial-in information for this conversation (admin free text containing the phone number etc)
- STUN server (v1|v2)
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)
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`
+ `404 Not Found`
### Internal signaling API
Todo
### External signaling API
See [External signaling API](standalone-signaling-api-v1.md) for the Signaling of the High-Performance Backend.
|
