docs/internal-signaling.md


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

# Signaling API

Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`

## 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 | Description
    ------|------|------------
    `signalingMode` | string | See [Signaling modes](constants.md#Signaling_modes)
    `userId` | string | Current user id
    `hideWarning` | string | Don't show a performance warning although internal signaling is used
    `server` | string | URL of the external signaling server
    `ticket` | string | Ticket for the external signaling server
    `stunservers` | array | STUN servers
    `turnservers` | array | TURN servers

    - STUN server
    
       field | type | Description
       ------|------|------------
       `url` | string | STUN server URL

    - TURN server
    
       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

* Response:
    - Header:
        + `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.