- Release notes
- Overview
- Getting started
- Marketplace Vendors
- Marketplace Customers
- Publishing Guidelines
- Publishing Guidelines for Ready-to-go Automations
- Publishing Guidelines for Solution Accelerators
- Publishing Guidelines for Integration Service Connectors
- Publishing Guidelines for Process Mining app templates
- Security & IP Protection
- Other UiPath Listings
- Node-RED
- Setup
- Teams
- Microsoft Teams scope
- Create team
- Create team from group
- Get team
- Get teams
- Channels
- Create channel
- Delete channel
- Get channel
- Get channels
- Update channel
- Chats
- Get chat
- Get chats
- Get chat members
- Messages
- Get message
- Get messages
- Get message replies
- Reply to message
- Send message
- Events
- Create event
- Delete event
- Get event
- Get events
- Users
- Get user presence
- How it works
- Technical references
- Get started
- About
- Setup
- Technical references
- Azure Form Recognizer scope
- Activities
- Analyze form
- Analyze form async
- Get analyze form result
- Analyze receipt
- Analyze receipt async
- Get analyze receipt result
- Analyze layout
- Analyze layout async
- Get analyze layout result
- Train model
- Get models
- Get model keys
- Get model info
- Delete model
- Connectors
- How to create activities
- Build Your Integration
Marketplace user guide
Get chat members
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 an 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.Idvalue (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 | String |
| Required | Yes |
| Default value | Get Chat Members |
| Allowed values | Enter a String or String variable. |
| Notes | N/A |
Input
ChatId
The Id of the Chat object that you want to retrieve a list of members from.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes |
| Default value | Empty |
| Allowed values | Enter a String or String variable. |
| Notes | To get the Chat.Id value, use an external process or activity that includes the Chat.Id value in its output (for example, Get Chats or external API call) |
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 | ConversationMember[] |
| Required | No (required if you plan to use the output data in subsequent activities) |
| Default value | Empty |
| Allowed values | Enter a ConversationMember[] variable. |
| Notes | The variable you create for this property can be used as an input variable in subsequent activities. The ConversationMember object includes multiple properties that you can use in other activities. The example image below shows some of the properties that you can return. |
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.
