Room Info

Returns information about a particular chat room.

Get information about a partcular chatroom.

get

/v3/room/{id}/info

Path parameters

idstringrequired

Room streamId

Header parameters

sessionTokenstringrequired

Session authentication token.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'yourpodURL.symphony.com/pod/v3/room/{id}/info' \
  --header 'sessionToken: text'

200

400

401

403

500

200

{
  "roomSystemInfo": {
    "id": "bjHSiY4iz3ar4iIh6-VzCX___peoM7cPdA",
    "creationDate": 1547661232368,
    "createdByUserId": 14362370637825,
    "active": true
  },
  "roomAttributes": {
    "name": "API room",
    "description": "Created via the API",
    "membersCanInvite": true,
    "discoverable": false,
    "readOnly": false,
    "copyProtected": false,
    "crossPod": false,
    "viewHistory": false,
    "multiLateralRoom": false,
    "public": false,
    "groupChat": false,
    "keywords": [
      {
        "key": "region",
        "value": "EMEA"
      },
      {
        "key": "lead",
        "value": "Bugs Bunny"
      }
    ]
  }
}

OK

📘 Stream ID

The stream ID can be located in the Symphony web or desktop client by clicking on the timestamp of any message in the conversation. This will open the Message Status module overlay, and the Conversation ID can be found in the overlay footer.

The stream ID in the UI is in Standard Base64 encoding. When the stream ID needs to be used in a URL, it should be in URLSafe Base64 encoding. To obtain the URLSafe Base64 stream ID, replace forward slashes with underscores, replace pluses with minuses, and ignore any trailing equal signs.

See Overview of streams for details.

📘 Note - Groups

Since 20.14, please note that the object groups has been added in the payload only if at least a Group has been added to the room. It is an array containing:

• id attribute: ID of the Group,

• addedBy: ID of the user who added the Group to the room

See Groups for more information.

🚧 Required Permissions

Rooms information can only be requested by:

• Members of the room

• Compliance Officers and Super Compliance Officers who are not members of the room

• Service Users with the User Provisioning role (members or not members of the room)

See Bot Permissions for a list of roles and associated privileges.