Create Room
Creates a new chatroom. See Room Attributes for room creation parameters.
Starting with SBE 20.14, it is possible to create External chat rooms with view history enabled, depending on a pod parameter.
Create a new chatroom.
Create a new chatroom.
If no attributes are specified, the room is created as a private chatroom.
Room name.
"API room"
Keywords for search to use to find this room
Room description.
"Created via the API"
If true, any chatroom participant can add new participants. If false, only owners can add new participants.
true
If true, this chatroom (name, description and messages) can be searched and listed by non-participants. If false, only participants can search this room.
false
If true, this is a public chatroom. IF false, a private chatroom.
false
If true, only stream owners can send messages.
false
If true, clients disable the clipboard copy for content in this stream.
false
If true, this room is a cross pod room
false
If true, new members can view the room chat history of the room.
false
If true, this is a multi lateral room where we can find users belonging to more than 2 companies.
false
If true, this room is for a scheduled meeting.
false
This field is ignored when creating a new room as it was only used for email integration which is now sunset.
UrlSafe message id of the pinned message inside the room. To perform unpin operation, send an empty string.
"vd7qwNb6hLoUV0BfXXPC43___oPIvkwJbQ"
If true, this room is a group chat. Note: this parameter is ignored for creating rooms. Since SBE 20.16.
false
OK
List of groups (aka SDLs) that were added to the room.
Starting with SBE 20.14, it is possible to create External chat rooms with view history enabled, depending on a pod parameter. See Room Attributes for room creation parameters.
🚧 More Information
Room names will be considered the same if they only differ in capitalization and whitespace. E.g. "room1" and "R O O M 1" are considered the same. Also, room names must be shorter than 50 characters.
viewHistory
,discoverable
andmembersCanInvite
attributes cannot be false ifpublic=true
.
readOnly
,public
anddiscoverable
attributes cannot be true ifcrossPod=true
.When 'crossPod' is true, then
viewHistory
can be true ONLY if the pod entitlement canCreateExternalRoomSharedHistory is enabled.
📘 Overview of streamsA stream is like a container for messages exchanged between two or more users via a given instant message (IM) or chat room. For more information, refer to Overview of streams.
🚧 Entitlements
A user needs to have the entitlement
canCreatePublicRoom
if he wants to create a public room (User entitlements are set on Admin Portal).A user needs to have the entitlement
isExternalRoomEnabled
if he wants to create a crosspod room (User entitlements are set on Admin Portal).
Last updated