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.

post

Create a new chatroom.

If no attributes are specified, the room is created as a private chatroom.

Header parameters
sessionTokenanyrequired

Session authentication token.

Body
namestringoptional

Room name.

Example: API room
keywordsobject[]optional

Keywords for search to use to find this room

Example: [{"key":"region","value":"EMEA"},{"key":"lead","value":"Daffy Duck"}]

descriptionstringoptional

Room description.

Example: Created via the API
membersCanInvitebooleanoptional

If true, any chatroom participant can add new participants. If false, only owners can add new participants.

Example: true
discoverablebooleanoptional

If true, this chatroom (name, description and messages) can be searched and listed by non-participants. If false, only participants can search this room.

publicbooleanoptional

If true, this is a public chatroom. IF false, a private chatroom.

readOnlybooleanoptional

If true, only stream owners can send messages.

copyProtectedbooleanoptional

If true, clients disable the clipboard copy for content in this stream.

crossPodbooleanoptional

If true, this room is a cross pod room

viewHistorybooleanoptional

If true, new members can view the room chat history of the room.

multiLateralRoombooleanoptional

If true, this is a multi lateral room where we can find users belonging to more than 2 companies.

scheduledMeetingbooleanoptional

If true, this room is for a scheduled meeting.

subTypestringoptional

This field is ignored when creating a new room as it was only used for email integration which is now sunset.

pinnedMessageIdstringoptional

UrlSafe message id of the pinned message inside the room. To perform unpin operation, send an empty string.

Example: vd7qwNb6hLoUV0BfXXPC43___oPIvkwJbQ
groupChatbooleanoptional

If true, this room is a group chat. Note: this parameter is ignored for creating rooms. Since SBE 20.16.

Responses
curl -L \
  --request POST \
  --url 'yourpodURL.symphony.com/pod/v3/room/create' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "API room",
    "keywords": [
      {
        "key": "region",
        "value": "EMEA"
      },
      {
        "key": "lead",
        "value": "Daffy Duck"
      }
    ],
    "description": "Created via the API",
    "membersCanInvite": true,
    "discoverable": false,
    "public": false,
    "readOnly": false,
    "copyProtected": false,
    "crossPod": false,
    "viewHistory": false,
    "multiLateralRoom": false,
    "scheduledMeeting": false,
    "subType": "text",
    "pinnedMessageId": "vd7qwNb6hLoUV0BfXXPC43___oPIvkwJbQ",
    "groupChat": false
  }'
{
  "roomAttributes": {
    "name": "API room",
    "keywords": [
      {
        "key": "region",
        "value": "EMEA"
      },
      {
        "key": "lead",
        "value": "Daffy Duck"
      }
    ],
    "description": "Created via the API",
    "membersCanInvite": true,
    "discoverable": false,
    "public": false,
    "readOnly": false,
    "copyProtected": false,
    "crossPod": false,
    "viewHistory": false,
    "multiLateralRoom": false,
    "scheduledMeeting": false,
    "subType": "text",
    "pinnedMessageId": "vd7qwNb6hLoUV0BfXXPC43___oPIvkwJbQ",
    "groupChat": false
  },
  "roomSystemInfo": {
    "id": "bjHSiY4iz3ar4iIh6-VzCX___peoM7cPdA",
    "creationDate": 1547661232368,
    "createdByUserId": 14362370637825,
    "active": true
  },
  "groups": [
    {
      "id": 68719476744,
      "addedBy": 68719476743
    }
  ]
}

OK

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 and membersCanInvite attributes cannot be false if public=true.

  • readOnly, public and discoverable attributes cannot be true if crossPod=true.

  • When 'crossPod' is true, then viewHistory can be true ONLY if the pod entitlement canCreateExternalRoomSharedHistory is enabled.

📘 Overview of streams

A 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

Was this helpful?