nextcloud-spreed/docs/capabilities.md

Capabilities

3.0 (Initial Talk release)

• audio - audio is supported
• video - video + screensharing is supported
• chat - simple text chat is supported, superseded by chat-v2

3.1

• guest-signaling - Guests can do signaling via api endpoints
• empty-group-room - Group conversations can be created without inviting a Nextcloud user group by default

3.2

• guest-display-names - Display names of guests are stored in the database, can be set via API (not WebRTC only) and are used on returned comments/participants/etc.
• multi-room-users - Users can be in multiple conversations at the same time now, therefor signaling now also requires the conversation token on the URL.
• chat-v2 - Chat messages are now Rich Object Strings and pagination is available, the previous chat is not available anymore.

4.0

• favorites (local) - Conversations can be marked as favorites which will pin them to the top of the conversation list.
• last-room-activity - Conversations have the lastActivity attribute and should be sorted by that instead of the last ping of the user.
• no-ping - The ping endpoint has been removed. Ping is updated with a call to fetch the signaling or chat messages instead.
• system-messages - Chat messages have a systemMessage attribute and can be generated by the system
• mention-flag - The conversation list populates the boolean unreadMention when the user was mentioned since their last visit
• in-call-flags - A new flag participantFlags has been introduced and is replacing the participantInCall boolean.

5.0

• invite-by-mail - Replaced by invite-groups-and-mails Guests can be invited with their email address
• notification-levels - Users can select when they want to be notified in conversations
• invite-groups-and-mails - Groups can be added to existing conversations via the add participant endpoint

6.0

• locked-one-to-one-rooms - One-to-one conversations are now locked to the users. Neither guests nor other participants can be added, so the options to do that should be hidden as well. Also a user can only leave a one-to-one conversation (not delete). It will be deleted when the other participant left too. If the other participant posts a new chat message or starts a call, the left-participant will be re-added.
• read-only-rooms - Conversations can be in read-only mode which means people can not do calls or write chat messages.

7.0

• chat-read-marker - The chat can be optionally marked read by clients manually, independent from the loading of the chat messages.
• webinary-lobby - See Webinary management for technical details.
• start-call-flag - Only moderators or users might be able to start calls.
• config => chat => max-length - Maximum length of chat messages

8.0

• chat-replies - Normal chat messages can now be replied to. Check the isReplyable parameter on the message object.
• circles-support - Conversations can be created for circles and all circle members can be added to existing conversations

9.0

• config => attachments => allowed (local) - Whether the user can upload files into a chat
• config => attachments => folder (local) - User defined folder where items should be uploaded to
• config => conversations => can-create (local) - Whether the user can create public and group conversations, if not only one-to-one conversations are allowed
• force-mute - "forceMute" signaling messages can be sent to mute other participants.
• conversation-v2 - The conversations API v2 is less load heavy and should be used by clients when available. Check the difference in the Conversation API documentation. Replaced by API v4 when conversation-v4 is set.
• chat-reference-id - a referenceId can be sent with a chat message to be able to identify it in parallel get requests to earlier fade out a temporary message. This feature is always enabled since Nextcloud 29

10.1

• conversation-v3 - Whether conversations API v3 is available Replaced by API v4 when conversation-v4 is set.
• sip-support - Whether SIP can be configured and enabled by moderators. The conversations API will come with some new values sipEnabled which signals whether this conversation has SIP configured as well as canEnableSIP to see if a user can enable it. When it is enabled attendeePin will contain the unique dial-in code for this user.

11.0

• chat-read-status (local) - On conversation API v3 and the chat API the last common read message is exposed which can be used to update the "read status" flag of own chat messages. The info should be shown only when the user also shares their read status. The user's value can be found in config => chat => read-privacy.
• listable-rooms (local) - Conversations can searched for even when not joined. A "listable" attribute set on rooms defines the scope of who can find it.
• phonebook-search (local) - Is present when the server has the endpoint to search for phone numbers to find matches in the accounts list
• raise-hand - Participants can raise or lower hand, the state change is sent through signaling messages.
• room-description - A description can be get and set for conversations.
• config => chat => read-privacy (local) - See chat-read-status
• config => previews => max-gif-size (local) - Maximum size in bytes below which a GIF can be embedded directly in the page at render time. Bigger files will be rendered statically using the preview endpoint instead. Can be set with occ config:app:set spreed max-gif-size --value=X where X is the new value in bytes. Defaults to 3 MB.

11.1

• delete-messages - Allows to delete chat messages up to 6 hours for your own messages or when being a moderator. On deleting the message text will be replaced and a follow up system message will make sure clients and users update it in their cache and storage.
• rich-object-sharing - Rich objects can be shared to chats. See OCP\RichObjectStrings\Definitions for more details on supported rich objects and required data.
• conversation-call-flags - Whether the room api provides the callFlag to tell apart video and audio calls
• temp-user-avatar-api (local) - Whether a temporary api is available to allow users to upload an avatar to their profile via an OCS endpoint.

12.0

• conversation-v4 - Whether conversations API v4 is available. This also means that v1, v2 and v3 are not available anymore. The changes on API v4 allow a user to have multiple sessions in the same conversation on different devices which is incompatible with the data structure that was used by the previous APIs.
• signaling-v3 - Whether signaling API v3 is available. This also means that v1 and v2 are not available anymore. The TURN and STUN server data is now returning all defined servers instead of a random one. Multiple entries for the same server are combined and using the urls array correctly now.
• geo-location-sharing - Whether the geo-location rich object is defined and can be shared to the rich-object sharing endpoint.
• voice-message-sharing - Shared files can be flagged as voice messages and are then presented differently in the interface
• publishing-permissions - Whether the publishing permissions can be set for the attendees.

12.1

• clear-history - Whether chat API has the endpoint so moderators can clear the complete history of a chat

13

• direct-mention-flag - The conversation list populates the boolean unreadMentionDirect when the user was mentioned directly (ignoring @all mentions) since their last visit
• notification-calls - Whether the API to opt out of call notifications is available
• conversation-permissions - Whether the default and custom permissions can be set for attendees.

14

• chat-unread - Whether the API to mark a conversation as unread is available
• reactions - Api reactions to chat message
• rich-object-list-media - When the API to get the chat messages for shared media is available
• rich-object-delete - When the API allows to delete chat messages which are file or rich object shares

15

• unified-search (local) - When the extended attributes of unified search results are there
• chat-permission - When permission 128 is required to post chat messages, reaction or share items to the conversation
• silent-send - Whether the chat API allows to send chat messages without triggering notifications
• message-expiration - Message expiration time for a conversation
• sip-support-nopin - Whether SIP can be configured to not require a custom attendee PIN
• send-call-notification - When the API allows to resend call notifications for individual users that did not join yet
• silent-call - Allow to start calls without sending notification
• talk-polls - Polls feature is available to use in the chat
• config => call => enabled - Whether calling is enabled on the instance or not
• config => signaling => session-ping-limit (local) - Number of sessions the HPB is allowed to ping in the same request
• config => signaling => hello-v2-token-key (local) - Public key to use when verifying JWT auth tokens for hello V2.

16

• breakout-rooms-v1 - Whether breakout-rooms API v1 is available
• recording-v1 - Call recording is available.
• chat-get-context - Whether the message context API endpoint is available
• config => call => breakout-rooms - Whether breakout rooms are enabled on this instance
• config => call => recording - Whether calls can be recorded (requires the High-performance backend server)
• single-conversation-status - When the response of a single conversation can also return the user status
• chat-keep-notifications - Whether messages can be retrieved without marking notifications as read

17

• avatar (local) - Avatar of conversation
• config => chat => translations - List of translations tuples, JSON encoded sample {"from":"de","fromLabel":"German","to":"en","toLabel":"English"}. Those tuples should be provided as options when translating chat messages. Due to some providers the list was too big causing issues in various clients. So the capability was replaced by boolean config => chat => has-translation-providers in Talk 18.
• config => call => predefined-backgrounds (local) - List of predefined virtual backgrounds. The files are in Talks img/ folder, accessible via the normal image path methods. The list is cached for 5 minutes.
• config => call => can-upload-background (local) - Boolean flag whether the user can upload a custom virtual background (requires an account and non-zero quota). Uploads should be done to Talk/Backgrounds/ (respecting the user's attachment directory setting).
• config => call => supported-reactions - A list of emojis supported as call reactions. If the list is absent or empty, clients should not show the emoji reaction option in calls.
• config => chat => typing-privacy (local) - User defined numeric value to enable 1 or disable 0 the typing indicator to other users
• typing-privacy - Support toggle typing privacy

17.1

• remind-me-later (local) - Support for "Remind me later" for chat messages exists
• bots-v1 - Support of the first version for Bots and Webhooks is available
• markdown-messages - Chat messages support markdown and are rendered automatically

18

• media-caption - Whether media caption can be added to shared files
• session-state - Sessions can mark themselves as inactive, so the participant receives notifications again
• note-to-self (local) - Support for "Note-to-self" conversation exists
• recording-consent - Whether admins and moderators can require recording consent before joining a call
• sip-support-dialout - Whether admins can enable SIP dial-out
• config => chat => has-translation-providers (local) - When true, translation tuples can be loaded from the OCS Translation API.
• config => call => recording-consent - Whether users need to consent into call recording before joining a call (see constants list)
• config => call => sip-enabled - Whether SIP is configured on the server allowing for SIP dial-in
• config => call => sip-dialout-enabled - Whether SIP dial-out is configured on the server, additionally requires config => call => sip-enabled
• config => call => can-enable-sip - Whether the current user is a member of the groups that are allowed to enable SIP dial-in on a conversation or use SIP dial-out

19

• delete-messages-unlimited - Whether messages can be deleted at any time (used to be restricted to 6 hours after posting)
• edit-messages - Whether messages can be edited (restricted to 24 hours after posting)
• silent-send-state - Whether messages contain a flag that they were sent silently
• chat-read-last - Whether chat can be marked read without giving a message ID (will fall back to the conversations last message ID)
• federation-v1 - Whether basic chatting is possible with federation
• config => federation => enabled (local) - Boolean, whether federation is enabled on instance
• config => federation => incoming-enabled (local) - Boolean, whether users are allowed to be invited into federated conversations on other servers
• config => federation => outgoing-enabled (local) - Boolean, whether users are allowed to invited federated users of other servers into conversations
• config => federation => only-trusted-servers (local) - Boolean, whether federation invites are limited to trusted servers

20

• ban-v1 - Whether the API to ban attendees is available
• mention-permissions - Whether non-moderators are allowed to mention @all
• federation-v2 - Whether federated session ids are used and calls are possible with federation
• edit-messages-note-to-self - Messages in note-to-self conversations can be edited indefinitely

20.1

• archived-conversations-v2 (local) - Conversations can be marked as archived which will hide them from the conversation list by default
• talk-polls-drafts - Whether moderators can store and retrieve poll drafts
• download-call-participants - Whether the endpoints for moderators to download the call participants is available
• chat-summary-api (local) - Whether the endpoint to get summarized chat messages in a conversation is available
• email-csv-import - Whether the endpoint to import a CSV email list as participants exists
• config => chat => summary-threshold (local) - Number of unread messages that should exist to show a "Generate summary" option
• config => call => start-without-media (local) - Boolean, whether media should be disabled when starting or joining a conversation
• config => call => max-duration - Integer, maximum call duration in seconds. Please note that this should only be used with system cron and with a reasonable high value, due to the expended duration until the background job ran.
• config => call => blur-virtual-background (local) - Boolean, whether blur background is set by default when joining a conversation

21

• config => conversations => force-passwords - Whether passwords are enforced for public rooms
• conversation-creation-password - Whether the endpoints for creating public conversations or making a conversation public support setting a password
• call-notification-state-api (local) - Whether the endpoints exist for checking if a call notification should be dismissed
• schedule-meeting (local) - Whether logged-in participants can schedule meetings
• config => chat => has-translation-task-providers (local) - When true, translations can be done using the OCS TaskProcessing API.
• config => conversations => list-style (local) - Whether conversation list should appear in certain way
• config => conversations => description-length (local) - The maximum length for conversation descriptions, currently 2000. Before this config was added the implicit limit was 500, since the existance of the feature capability room-description.
• call-end-to-end-encryption - Signaling support of the server for the end-to-end encryption of calls
• config => call => end-to-end-encryption - Whether calls should be end-to-end encrypted (currently off by default, until all Talk mobile clients support it)

• edit-draft-poll - Whether moderators can edit draft polls

21.1

• conversation-creation-all (local) - Whether the conversation creation endpoint allows to specify all attributes of a conversation
• sip-direct-dialin (local) - Whether the SIP bridge can create conversations when an external participant calls a mapped phone number
• important-conversations (local) - Whether important conversations are supported
• unbind-conversation - Whether the API exists to make an event and phone conversation persistent
• config => conversations => retention-event - Number of days before an inactive event conversation is deleted (0 = disabled)
• config => conversations => retention-instant-meetings - Number of days before an instant meeting conversation is deleted (0 = disabled)
• config => conversations => retention-phone - Number of days before an inactive incoming or outgoing phone conversation is deleted (0 = disabled)
• config => call => predefined-backgrounds-v2 (local) - Whether virtual backgrounds should be read from the theming directory
• config => experiments => enabled (local) - Bit flag of enabled experiments for clients
• dashboard-event-rooms (local) - Whether Talk APIs offer functionality for Dashboard requests
• mutual-calendar-events (local) - Whether Talk APIs offer mutual calendar events for 1:1 rooms
• upcoming-reminders (local) - Whether the API to list upcoming reminders exists
• sensitive-conversations (local) - Whether sensitive conversations are supported

22

• threads - Whether the chat supports threads