Overview
The Get Chat Members activity calls the Microsoft Graph ListConversationMembers API to retrieve the members of a specified chat (ChatId).
After retrieving the members, the activity returns an array of their properties in a ConversationMember[]
object (ChatMembers) that you can use as in input variable in subsequent activities.
How it works
The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.
- Complete the Setup steps.
- Add the Microsoft Teams Scope activity to your project.
- Add an activity or run an external process that outputs a
Chat.Id
value (e.g., Get Chats). - Add the Get Chat Members activity inside the Microsoft Teams Scope activity.
- Enter a value for the Input property.
- Create and enter a
ConversationMember[]
variable for your Output property. - Run the activity.
- Your input property values are sent to the ListConversationMembers API.
- The API returns the
ConversationMember[]
value to your output property variable.


Properties
The values for the following properties are specified when adding this activity to your project in UiPath Studio.


Common
DisplayName
The display name of the activity.
Attributes | Details |
---|---|
Type |
|
Required | Yes |
Default value | Get Chat Members |
Allowed values | Enter a |
Notes | N/A |
Input
ChatId
The Id of the Chat
object that you want to retrieve a list of members from.
Attributes | Details |
---|---|
Type |
|
Required | Yes |
Default value | Empty |
Allowed values | Enter a |
Notes | To get the |
Misc
Private
If selected, the values of variables and arguments are no longer logged at Verbose level.
Attributes | Details |
---|---|
Type | Checkbox |
Required | No |
Default value | Not Selected |
Allowed values | Selected or Not Selected |
Notes | N/A |
Output
ChatMembers
A list of members and their properties (ConversationMember[]
object) from the specified chat.
Attributes | Details |
---|---|
Type |
|
Required | No (required if you plan to use the output data in subsequent activities) |
Default value | Empty |
Allowed values | Enter a |
Notes | The variable you create for this property can be used as an input variable in subsequent activities. |
Example
The following image shows an example of the activity dependency relationship and input/output property values.
For step-by-step instructions and examples, see the Quickstart guides.


Updated 5 months ago