Room Members

Lists the current members of an existing room.

Lists current members of an existing room.

GETyourpodURL.symphony.com/pod/v2/room/{id}/membership/list

Path parameters

id*string

Room streamId

Header parameters

Response

200400401403500

OK

Body

application/json

idinteger (int64)

Example: 7078106103810

ownerboolean

Example: true

joinDateinteger (int64)

Example: 1461426797833

addedThroughGroupsarray of integer (int64)

When the user has been added to the stream through a group (aka SDL), this array contains the group ID which the user belongs to. Since SBE 20.14.

Request

JavaScriptCurlPython

const response = await fetch('yourpodURL.symphony.com/pod/v2/room/{id}/membership/list', {
    method: 'GET',
    headers: {
      "sessionToken": "text"
    },
});
const data = await response.json();

Response

200400401403500

[
  {
    "id": 7078106103900,
    "owner": false,
    "joinDate": 1461430710531
  },
  {
    "id": 7078106103809,
    "owner": true,
    "joinDate": 1461426797875
  },
  {
    "id": 7078106103810,
    "owner": true,
    "joinDate": 1461426797833,
    "addedThroughGroups": [
      68719476744
    ]
  }
]

🚧 Required Permissions

Room membership can only be read by:

• Members of the room.

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

• Service Users who are members of the room. If not a member, the User Provisioning role is needed.

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

📘 Room ID and User ID

Room ID

The room 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 room ID in the UI is in Standard Base64 encoding. When the room ID needs to be used in a URL, it should be in URLSafe Base64 encoding. To obtain the URLSafe Base64 room ID, replace forward slashes with underscores, replace pluses with minuses, and ignore any trailing equal signs.

Visit Overview for an overview of streams.

User ID

The user id returns a long numeric type.

📘 Note - Groups

Since 20.14, please note that the object addedThroughGroups has been added only for members added to the room via Groups.

See Groups for more information.