зеркало из https://github.com/nextcloud/spreed.git
Add versions to API docs (sorry for cleaning up)
Signed-off-by: Joas Schilling <coding@schilljs.com>
This commit is contained in:
Родитель
4733fe150f
Коммит
bed14653db
17
docs/call.md
17
docs/call.md
|
@ -20,13 +20,14 @@
|
|||
- Data:
|
||||
Array of participants, each participant has at least:
|
||||
|
||||
field | type | API | Description
|
||||
------|------|-----|------------
|
||||
`actorType` | string | v4 | Actor type of the attendee (see [Constants - Attendee types](constants.md#attendee-types))
|
||||
`actorId` | string | v4 | The user id, guest random id or email address of the attendee
|
||||
`displayName` | string | v4 | The display name of the attendee
|
||||
`lastPing` | int | v4 | Timestamp of the last ping of the user (should be used for sorting)
|
||||
`sessionId` | string | v4 | 512 character long string
|
||||
field | type | Added | Removed | Description
|
||||
---|---|---|---|---
|
||||
`actorType` | string | v3 | | Actor type of the attendee (see [Constants - Attendee types](constants.md#attendee-types))
|
||||
`actorId` | string | v3 | | The user id, guest random id or email address of the attendee
|
||||
`userId` | string | v1 | v3 | The user id replaced with actorType = users and actorId being the userId
|
||||
`displayName` | string | v3 | | The display name of the attendee
|
||||
`lastPing` | int | v1 | | Timestamp of the last ping of the user (should be used for sorting)
|
||||
`sessionId` | string | v1 | | 512 character long string
|
||||
|
||||
## Join a call
|
||||
|
||||
|
@ -35,7 +36,7 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`flags` | int | Flags what streams are provided by the participant (see [Constants - Participant in-call flag](constants.md#participant-in-call-flag))
|
||||
|
||||
* Response:
|
||||
|
|
26
docs/chat.md
26
docs/chat.md
|
@ -9,7 +9,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`lookIntoFuture` | int | `1` Poll and wait for new message or `0` get history of a conversation
|
||||
`limit` | int | Number of chat messages to receive (100 by default, 200 at most)
|
||||
`lastKnownMessageId` | int | Serves as an offset for the query. The lastKnownMessageId for the next page is available in the `X-Chat-Last-Given` header.
|
||||
|
@ -28,7 +28,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
|
|||
- Header:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`X-Chat-Last-Given` | int | Offset (lastKnownMessageId) for the next page.
|
||||
`X-Chat-Last-Common-Read` | int | ID of the last message read by every user that has read privacy set to public. When the user themself has it set to private the value the header is not set (only available with `chat-read-status` capability and when lastCommonReadId was sent)
|
||||
|
||||
|
@ -36,7 +36,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
|
|||
Array of messages, each message has at least:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`id` | int | ID of the comment
|
||||
`token` | string | Conversation token
|
||||
`actorType` | string | `guests` or `users`
|
||||
|
@ -56,7 +56,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
|
|||
* When deleted:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`id` | int | ID of the parent comment
|
||||
`deleted` | bool | `true` when the parent is deleted
|
||||
|
||||
|
@ -72,7 +72,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`message` | string | The message the user wants to say
|
||||
`actorDisplayName` | string | Guest display name (ignored for logged in users)
|
||||
`replyTo` | int | The message ID this message is a reply to (only allowed for messages from the same conversation and when the message type is not `system` or `command`)
|
||||
|
@ -90,7 +90,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
|
|||
- Header:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`X-Chat-Last-Common-Read` | int | ID of the last message read by every user that has read privacy set to public. When the user themself has it set to private the value the header is not set (only available with `chat-read-status` capability)
|
||||
|
||||
- Data:
|
||||
|
@ -106,7 +106,7 @@ See [OCP\RichObjectStrings\Definitions](https://github.com/nextcloud/server/blob
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`objectType` | string | The object type
|
||||
`objectId` | string | The object id
|
||||
`metaData` | string | JSON encoded array of the rich objects data
|
||||
|
@ -125,7 +125,7 @@ See [OCP\RichObjectStrings\Definitions](https://github.com/nextcloud/server/blob
|
|||
- Header:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`X-Chat-Last-Common-Read` | int | ID of the last message read by every user that has read privacy set to public. When the user themself has it set to private the value the header is not set (only available with `chat-read-status` capability)
|
||||
|
||||
- Data:
|
||||
|
@ -151,7 +151,7 @@ See [OCP\RichObjectStrings\Definitions](https://github.com/nextcloud/server/blob
|
|||
- Header:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`X-Chat-Last-Common-Read` | int | ID of the last message read by every user that has read privacy set to public. When the user themself has it set to private the value the header is not set (only available with `chat-read-status` capability)
|
||||
|
||||
- Data:
|
||||
|
@ -168,7 +168,7 @@ See [OCP\RichObjectStrings\Definitions](https://github.com/nextcloud/server/blob
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`lastReadMessage` | int | The last read message ID
|
||||
|
||||
* Response:
|
||||
|
@ -180,7 +180,7 @@ See [OCP\RichObjectStrings\Definitions](https://github.com/nextcloud/server/blob
|
|||
- Header:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`X-Chat-Last-Common-Read` | int | ID of the last message read by every user that has read privacy set to public. When the user themself has it set to private the value the header is not set (only available with `chat-read-status` capability)
|
||||
|
||||
|
||||
|
@ -191,7 +191,7 @@ See [OCP\RichObjectStrings\Definitions](https://github.com/nextcloud/server/blob
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`search` | string | Search term for name suggestions (should at least be 1 character)
|
||||
`limit` | int | Number of suggestions to receive (20 by default)
|
||||
`includeStatus` | bool | Whether the user status information also needs to be loaded
|
||||
|
@ -207,7 +207,7 @@ See [OCP\RichObjectStrings\Definitions](https://github.com/nextcloud/server/blob
|
|||
Array of suggestions, each suggestion has at least:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`id` | string | The user id which should be sent as `@<id>` in the message (user ids that contain spaces as well as guest ids need to be wrapped in double-quotes when sending in a message: `@"space user"` and `@"guest/random-string"`)
|
||||
`label` | string | The displayname of the user
|
||||
`source` | string | The type of the user, currently only `users`, `guests` or `calls` (for mentioning the whole conversation
|
||||
|
|
|
@ -18,52 +18,55 @@
|
|||
- Header:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`X-Nextcloud-Talk-Hash` | string | Sha1 value over some config. When you receive a different value on subsequent requests, the capabilities and the signaling settings should be refreshed.
|
||||
|
||||
- Data:
|
||||
Array of conversations, each conversation has at least:
|
||||
|
||||
field | type | API | Description
|
||||
------|------|-----|------------
|
||||
`token` | string | * | Token identifier of the conversation which is used for further interaction
|
||||
`type` | int | * | See list of conversation types in the [constants list](constants.md#conversation-types)
|
||||
`name` | string | * | Name of the conversation (can also be empty)
|
||||
`displayName` | string | * | `name` if non empty, otherwise it falls back to a list of participants
|
||||
`description` | string | * | Description of the conversation (can also be empty) (only available with `room-description` capability)
|
||||
`participantType` | int | * | Permissions level of the current user
|
||||
`attendeeId` | int | * | Unique attendee id
|
||||
`attendeePin` | string | * | Unique dial-in authentication code for this user, when the conversation has SIP enabled (see `sipEnabled` attribute)
|
||||
`actorType` | string | * | Currently known `users|guests|emails|groups`
|
||||
`actorId` | string | * | The unique identifier for the given actor type
|
||||
`participantInCall` | 🏁 | 🏁 | **Removed:** use `participantFlags` instead
|
||||
`participantFlags` | int | * | "In call" flags of the user's session making the request (only available with `in-call-flags` capability)
|
||||
`readOnly` | int | * | Read-only state for the current user (only available with `read-only-rooms` capability)
|
||||
`listable` | int | * | Listable scope for the room (only available with `listable-rooms` capability)
|
||||
`count` | 🏁 | 🏁 | **Removed:** Count the users on the [Get list of participants in a conversation](participant.md#get-list-of-participants-in-a-conversation) endpoint
|
||||
`numGuests` | 🏁 | 🏁 | **Removed:** Count the guests on the [Get list of participants in a conversation](participant.md#get-list-of-participants-in-a-conversation) endpoin
|
||||
`lastPing` | int | * | Timestamp of the user's session making the request
|
||||
`sessionId` | string | * | `'0'` if not connected, otherwise an up to 512 character long string that is the identifier of the user's session making the request. Should only be used to pre-check if the user joined already with this session, but this might be outdated by the time of usage, so better check via [Get list of participants in a conversation](participant.md#get-list-of-participants-in-a-conversation)
|
||||
`hasPassword` | bool | * | Flag if the conversation has a password
|
||||
`hasCall` | bool | * | Flag if the conversation has an active call
|
||||
`callFlag` | int | * | Combined flag of all participants in the current call (see [constants list](constants.md#participant-in-call-flag), only available with `conversation-call-flags` capability)
|
||||
`canStartCall` | bool | * | Flag if the user can start a new call in this conversation (joining is always possible) (only available with `start-call-flag` capability)
|
||||
`canDeleteConversation` | bool | * | Flag if the user can delete the conversation for everyone (not possible without moderator permissions or in one-to-one conversations)
|
||||
`canLeaveConversation` | bool | * | Flag if the user can leave the conversation (not possible for the last user with moderator permissions)
|
||||
`lastActivity` | int | * | Timestamp of the last activity in the conversation, in seconds and UTC time zone
|
||||
`isFavorite` | bool | * | Flag if the conversation is favorited by the user
|
||||
`notificationLevel` | int | * | The notification level for the user (See [Participant notification levels](constants.md#Participant-notification-levels))
|
||||
`lobbyState` | int | * | Webinar lobby restriction (0-1), if the participant is a moderator they can always join the conversation (only available with `webinary-lobby` capability) (See [Webinar lobby states](constants.md#webinar-lobby-states))
|
||||
`lobbyTimer` | int | * | Timestamp when the lobby will be automatically disabled (only available with `webinary-lobby` capability)
|
||||
`sipEnabled` | int | * | SIP enable status (0-1)
|
||||
`canEnableSIP` | int | * | Whether the given user can enable SIP for this conversation. Note that when the token is not-numeric only, SIP can not be enabled even if the user is permitted and a moderator of the conversation
|
||||
`unreadMessages` | int | * | Number of unread chat messages in the conversation (only available with `chat-v2` capability)
|
||||
`unreadMention` | bool | * | Flag if the user was mentioned since their last visit
|
||||
`lastReadMessage` | int | * | ID of the last read message in a room (only available with `chat-read-marker` capability)
|
||||
`lastCommonReadMessage` | int | * | ID of the last message read by every user that has read privacy set to public in a room. When the user themself has it set to private the value is `0` (only available with `chat-read-status` capability)
|
||||
`lastMessage` | message | * | Last message in a conversation if available, otherwise empty
|
||||
`objectType` | string | * | The type of object that the conversation is associated with; "share:password" if the conversation is used to request a password for a share, otherwise empty
|
||||
`objectId` | string | * | Share token if "objectType" is "share:password", otherwise empty
|
||||
field | type | Added | Removed | Description
|
||||
---|---|---|---|---
|
||||
`id` | int | v1 | | Numeric identifier of the conversation
|
||||
`token` | string | v1 | | Token identifier of the conversation which is used for further interaction
|
||||
`type` | int | v1 | | See list of conversation types in the [constants list](constants.md#conversation-types)
|
||||
`name` | string | v1 | | Name of the conversation (can also be empty)
|
||||
`displayName` | string | v1 | | `name` if non empty, otherwise it falls back to a list of participants
|
||||
`description` | string | v3 | | Description of the conversation (can also be empty) (only available with `room-description` capability)
|
||||
`participantType` | int | v1 | | Permissions level of the current user
|
||||
`attendeeId` | int | v3 | | Unique attendee id
|
||||
`attendeePin` | string | v3 | | Unique dial-in authentication code for this user, when the conversation has SIP enabled (see `sipEnabled` attribute)
|
||||
`actorType` | string | v3 | | Currently known `users|guests|emails|groups`
|
||||
`actorId` | string | v3 | | The unique identifier for the given actor type
|
||||
`participantInCall` | bool | v1 | v2 | **Removed:** use `participantFlags` instead
|
||||
`participantFlags` | int | v1 | | "In call" flags of the user's session making the request (only available with `in-call-flags` capability)
|
||||
`readOnly` | int | v1 | | Read-only state for the current user (only available with `read-only-rooms` capability)
|
||||
`listable` | int | v3 | | Listable scope for the room (only available with `listable-rooms` capability)
|
||||
`count` | int | v1 | v2 | **Removed:** Count the users on the [Get list of participants in a conversation](participant.md#get-list-of-participants-in-a-conversation) endpoint
|
||||
`numGuests` | int | v1 | v2 | **Removed:** Count the guests on the [Get list of participants in a conversation](participant.md#get-list-of-participants-in-a-conversation) endpoin
|
||||
`lastPing` | int | v1 | | Timestamp of the user's session making the request
|
||||
`sessionId` | string | v1 | | `'0'` if not connected, otherwise an up to 512 character long string that is the identifier of the user's session making the request. Should only be used to pre-check if the user joined already with this session, but this might be outdated by the time of usage, so better check via [Get list of participants in a conversation](participant.md#get-list-of-participants-in-a-conversation)
|
||||
`hasPassword` | bool | v1 | | Flag if the conversation has a password
|
||||
`hasCall` | bool | v1 | | Flag if the conversation has an active call
|
||||
`callFlag` | int | v3 | | Combined flag of all participants in the current call (see [constants list](constants.md#participant-in-call-flag), only available with `conversation-call-flags` capability)
|
||||
`canStartCall` | bool | v1 | | Flag if the user can start a new call in this conversation (joining is always possible) (only available with `start-call-flag` capability)
|
||||
`canDeleteConversation` | bool | v2 | | Flag if the user can delete the conversation for everyone (not possible without moderator permissions or in one-to-one conversations)
|
||||
`canLeaveConversation` | bool | v2 | | Flag if the user can leave the conversation (not possible for the last user with moderator permissions)
|
||||
`lastActivity` | int | v1 | | Timestamp of the last activity in the conversation, in seconds and UTC time zone
|
||||
`isFavorite` | bool | v1 | | Flag if the conversation is favorited by the user
|
||||
`notificationLevel` | int | v1 | | The notification level for the user (See [Participant notification levels](constants.md#Participant-notification-levels))
|
||||
`lobbyState` | int | v1 | | Webinar lobby restriction (0-1), if the participant is a moderator they can always join the conversation (only available with `webinary-lobby` capability) (See [Webinar lobby states](constants.md#webinar-lobby-states))
|
||||
`lobbyTimer` | int | v1 | | Timestamp when the lobby will be automatically disabled (only available with `webinary-lobby` capability)
|
||||
`sipEnabled` | int | v3 | | SIP enable status (0-1)
|
||||
`canEnableSIP` | int | v3 | | Whether the given user can enable SIP for this conversation. Note that when the token is not-numeric only, SIP can not be enabled even if the user is permitted and a moderator of the conversation
|
||||
`unreadMessages` | int | v1 | | Number of unread chat messages in the conversation (only available with `chat-v2` capability)
|
||||
`unreadMention` | bool | v1 | | Flag if the user was mentioned since their last visit
|
||||
`lastReadMessage` | int | v1 | | ID of the last read message in a room (only available with `chat-read-marker` capability)
|
||||
`lastCommonReadMessage` | int | v3 | | ID of the last message read by every user that has read privacy set to public in a room. When the user themself has it set to private the value is `0` (only available with `chat-read-status` capability)
|
||||
`lastMessage` | message | v1 | | Last message in a conversation if available, otherwise empty
|
||||
`objectType` | string | v1 | | The type of object that the conversation is associated with; "share:password" if the conversation is used to request a password for a share, otherwise empty
|
||||
`objectId` | string | v1 | | Share token if "objectType" is "share:password", otherwise empty
|
||||
`participants` | array | v1 | v2 | **Removed**
|
||||
`guestList` | string | v1 | v2 | **Removed**
|
||||
|
||||
## Creating a new conversation
|
||||
|
||||
|
@ -72,7 +75,7 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`roomType` | int | See [constants list](constants.md#conversation-types)
|
||||
`invite` | string | user id (`roomType = 1`), group id (`roomType = 2` - optional), circle id (`roomType = 2`, `source = 'circles'`], only available with `circles-support` capability))
|
||||
`source` | string | The source for the invite, only supported on `roomType = 2` for `groups` and `circles` (only available with `circles-support` capability)
|
||||
|
@ -102,7 +105,7 @@
|
|||
- Header:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`X-Nextcloud-Talk-Hash` | string | Sha1 value over some config. When you receive a different value on subsequent requests, the capabilities and the signaling settings should be refreshed.
|
||||
|
||||
- Data: See array definition in `Get user´s conversations`
|
||||
|
@ -121,7 +124,7 @@
|
|||
- Header:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`searchTerm` | string | search term
|
||||
|
||||
- Data: See array definition in `Get user´s conversations`
|
||||
|
@ -133,7 +136,7 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`roomName` | string | New name for the conversation (1-200 characters)
|
||||
|
||||
* Response:
|
||||
|
@ -164,7 +167,7 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`description` | string | New description for the conversation
|
||||
|
||||
* Response:
|
||||
|
@ -207,7 +210,7 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`state` | int | New state for the conversation, see [constants list](constants.md#read-only-states)
|
||||
|
||||
* Response:
|
||||
|
@ -224,7 +227,7 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`password` | string | New password for the conversation
|
||||
|
||||
* Response:
|
||||
|
@ -266,7 +269,7 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`level` | int | The notification level (See [Participant notification levels](constants.md#Participant-notification-levels))
|
||||
|
||||
* Response:
|
||||
|
@ -284,7 +287,7 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`scope` | int | New flags for the conversation
|
||||
|
||||
* Response:
|
||||
|
|
|
@ -9,7 +9,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`fileId` | int | File id for which the conversation should be given
|
||||
|
||||
* Response:
|
||||
|
@ -23,7 +23,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
|
|||
- Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`token` | string | The token of the conversation for this file
|
||||
|
||||
## Get conversation for a public share
|
||||
|
@ -33,7 +33,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`shareToken` | string | Share token for which the conversation should be given
|
||||
|
||||
* Response:
|
||||
|
@ -46,7 +46,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
|
|||
- Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`token` | string | The token of the conversation for this file
|
||||
|
||||
## Create a conversation to request the password for a public share
|
||||
|
@ -56,7 +56,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`shareToken` | string | Share token for which the conversation should be given
|
||||
|
||||
* Response:
|
||||
|
@ -68,7 +68,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
|
|||
- Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`token` | string | The token of the conversation for this file
|
||||
`name` | string | A technical name for the conversation
|
||||
`displayName` | string | The visual name of the conversation
|
||||
|
|
|
@ -10,32 +10,32 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`token` | string | The conversation to get the signaling settings for
|
||||
|
||||
* Response:
|
||||
|
||||
field | type | API | 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
|
||||
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
|
||||
|
||||
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
|
||||
|
|
|
@ -12,7 +12,7 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`includeStatus` | bool | Whether the user status information also needs to be loaded
|
||||
|
||||
* Response:
|
||||
|
@ -25,19 +25,20 @@
|
|||
- Data:
|
||||
Array of participants, each participant has at least:
|
||||
|
||||
field | type | API | Description
|
||||
------|------|-----|------------
|
||||
`attendeeId` | int | * | Unique attendee id
|
||||
`actorType` | string | * | Currently known `users|guests|emails|groups`
|
||||
`actorId` | string | * | The unique identifier for the given actor type
|
||||
`displayName` | string | * | Can be empty for guests
|
||||
`participantType` | int | * | Permissions level of the participant (see [constants list](constants.md#participant-types))
|
||||
`lastPing` | int | * | Timestamp of the last ping of the user (should be used for sorting)
|
||||
`inCall` | int | * | Call flags the user joined with (see [constants list](constants.md#participant-in-call-flag))
|
||||
`sessionIds` | array | * | array of session ids, each are 512 character long strings, or empty if no session
|
||||
`status` | string | * | Optional: Only available with `includeStatus=true`, for users with a set status and when there are less than 100 participants in the conversation
|
||||
`statusIcon` | string | * | Optional: Only available with `includeStatus=true`, for users with a set status and when there are less than 100 participants in the conversation
|
||||
`statusMessage` | string | * | Optional: Only available with `includeStatus=true`, for users with a set status and when there are less than 100 participants in the conversation
|
||||
field | type | Added | Removed | Description
|
||||
---|---|---|---|---
|
||||
`attendeeId` | int | v3 | | Unique attendee id
|
||||
`actorType` | string | v3 | | Currently known `users|guests|emails|groups`
|
||||
`actorId` | string | v3 | | The unique identifier for the given actor type
|
||||
`displayName` | string | v1 | | Can be empty for guests
|
||||
`participantType` | int | v1 | | Permissions level of the participant (see [constants list](constants.md#participant-types))
|
||||
`lastPing` | int | v1 | | Timestamp of the last ping of the user (should be used for sorting)
|
||||
`inCall` | int | v1 | | Call flags the user joined with (see [constants list](constants.md#participant-in-call-flag))
|
||||
`sessionId` | string | v1 | v4 | `'0'` if not connected, otherwise a 512 character long string
|
||||
`sessionIds` | array | v4 | | array of session ids, each are 512 character long strings, or empty if no session
|
||||
`status` | string | v2 | | Optional: Only available with `includeStatus=true`, for users with a set status and when there are less than 100 participants in the conversation
|
||||
`statusIcon` | string | v2 | | Optional: Only available with `includeStatus=true`, for users with a set status and when there are less than 100 participants in the conversation
|
||||
`statusMessage` | string | v2 | | Optional: Only available with `includeStatus=true`, for users with a set status and when there are less than 100 participants in the conversation
|
||||
|
||||
## Add a participant to a conversation
|
||||
|
||||
|
@ -46,7 +47,7 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`newParticipant` | string | User, group, email or circle to add
|
||||
`source` | string | Source of the participant(s) as returned by the autocomplete suggestion endpoint (default is `users`)
|
||||
|
||||
|
@ -62,7 +63,7 @@
|
|||
- Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`type` | int | In case the conversation type changed, the new value is returned
|
||||
|
||||
## Delete an attendee by id from a conversation
|
||||
|
@ -72,7 +73,7 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`attendeeId` | int | The participant to delete
|
||||
|
||||
* Response:
|
||||
|
@ -103,7 +104,7 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`password` | string | Optional: Password is only required for users which are self joined or guests and only when the conversation has `hasPassword` set to true.
|
||||
`force` | bool | If set to `false` and the user has an active session already a `409 Conflict` will be returned (Default: true - to keep the old behaviour)
|
||||
|
||||
|
@ -119,7 +120,7 @@
|
|||
- Data in case of `409 Conflict`:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`sessionId` | string | 512 character long string
|
||||
`inCall` | int | Flags whether the conflicting session is in a potential call
|
||||
`lastPing` | int | Timestamp of the last ping of the conflicting session
|
||||
|
@ -132,7 +133,7 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`attendeeId` | int or null | Attendee id can be used for guests and users, not setting it will resend all invitations
|
||||
|
||||
* Response:
|
||||
|
@ -158,7 +159,7 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`attendeeId` | int | Attendee id can be used for guests and users
|
||||
|
||||
* Response:
|
||||
|
@ -177,7 +178,7 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`attendeeId` | int | Attendee id can be used for guests and users
|
||||
|
||||
* Response:
|
||||
|
@ -213,7 +214,7 @@ Note: This is only allowed with validate SIP bridge requests
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`displayName` | string | The new display name
|
||||
|
||||
* Response:
|
||||
|
|
|
@ -9,7 +9,7 @@
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`key` | string | The user config to set
|
||||
`value` | string/int | The value to set
|
||||
|
||||
|
@ -22,7 +22,7 @@
|
|||
## User settings
|
||||
|
||||
Key | Capability | Default | Valid values
|
||||
----|------------|---------|-------------
|
||||
---|---|---|---
|
||||
`attachment_folder` | `config => attachments => folder` | `/Talk` | Path owned by the user to store uploads and received shares. It is created if it does not exist.
|
||||
`read_status_privacy` | `config => chat => read-privacy` | `0` | One of the read-status constants from the [constants list](constants.md#Participant-read-status-privacy)
|
||||
|
||||
|
@ -36,7 +36,7 @@ Key | Capability | Default | Valid values
|
|||
All values must be sent in the same request
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`sipGroups` | array | List of group ids that are allow to enable SIP for a conversation
|
||||
`dialInInfo` | string | The dial-in information shown in the sidebar and sent in emails
|
||||
`sharedSecret` | string | The shared secret of the SIP component
|
||||
|
|
|
@ -21,7 +21,7 @@ Group and public conversations can be used to host webinars. Those online meetin
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`state` | int | New state for the conversation
|
||||
`timer` | int/null | Timestamp when the lobby state is reset to no lobby
|
||||
|
||||
|
@ -43,7 +43,7 @@ Group and public conversations can be used to host webinars. Those online meetin
|
|||
* Data:
|
||||
|
||||
field | type | Description
|
||||
------|------|------------
|
||||
---|---|---
|
||||
`state` | int | New SIP state for the conversation (0 = disabled, 1 = enabled)
|
||||
|
||||
* Response:
|
||||
|
|
|
@ -368,7 +368,6 @@ class RoomController extends AEnvironmentAwareController {
|
|||
'lobbyTimer' => 0,
|
||||
'lastPing' => 0,
|
||||
'sessionId' => '0',
|
||||
'guestList' => '',
|
||||
'lastMessage' => [],
|
||||
'sipEnabled' => Webinary::SIP_DISABLED,
|
||||
'actorType' => '',
|
||||
|
|
Загрузка…
Ссылка в новой задаче