diff options
Diffstat (limited to 'docs/internal-signaling.md')
| -rw-r--r-- | docs/internal-signaling.md | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/docs/internal-signaling.md b/docs/internal-signaling.md index 8bdf3830b..fc75d4e29 100644 --- a/docs/internal-signaling.md +++ b/docs/internal-signaling.md @@ -10,36 +10,36 @@ * Endpoint: `/signaling/settings` * Data: - field | type | Description - ---|---|--- - `token` | string | The conversation to get the signaling settings for +| 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 | 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) +| 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 | 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 - - field | type | Description - ------|------|------------ - `urls` | array | Each element is a STUN server URL as a string + +| field | type | Description | +|--------|-------|-----------------------------------------------| +| `urls` | array | Each element is a STUN server URL as a string | - TURN server - - 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 + +| 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: |