Released in 1.51
Returns information about a particular stream.
Note: visit Overview for an overview of streams.
In the response,
crossPodfield indicates whether the stream is External or Internal.
originfield indicates the origin of the room: INTERNAL (created by a user of the calling user's company) or EXTERNAL (created by a user of another company). Only applies to chatrooms with External scope.
activefield indicates whether the stream is active or inactive. An IM/MIM is inactive if at least one of the participants is a deactivated user. A room is inactive if it has been deactivated by an owner or an administrator.
lastMessageDatestates when the last message sent in that stream. The time is in epoch format.
IM(1-1 instant message),
MIM(multi-party instant message),
POST(user profile wall posts).
- For IMs, MIMs, and walls,
membersarray with userIds of participants. In the case of wall posts, there is only one participant (the user whose wall it is).
- For rooms,
nameof the room. To get the participants of the room, call the Room Members endpoint.
- If the stream is IM/MIM or rooms with
discoverableset as "false", the caller needs to have the VIEW_ANY_STREAM_DETAILS privilege. Refer to Bot Permissions for a list of roles and associated privileges.
Note - Groups
Since 20.14, please note that the object
groupshas been added in the roomAttributes object only if at least a Group has been added to the room. It is an array containing:
idattribute: ID of the Group,
addedBy: ID of the user who added the Group to the room
See Groups for more information.