- 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 messages
Overview
The Get Messages activity calls the Microsoft Graph ListChatMessages or ListChannelMessages API to retrieve all messages from a specified chat (ChatId) or channel (ChannelId) and team (TeamID).
After performing the search, the activity outputs the properties in a ChatMessage[] object (Message) that you can use as input variables in subsequent activities (for example, ChatMessage(0).Id in Get Message Replies, Reply To Message, and so on).
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.
- Complete one of the following two options (A or B):
A. Add an activity or run an external process that outputs a Chat.Id value (e.g., Get Chats).
B. Add an activity or run an external process that outputs a Team.Id value (for example, Get Teams) AND an activity or external process that outputs a Channel.Id value (for example, Get Channels).
- Add the Get Messages activity inside the Microsoft Teams Scope activity.
- Enter values for the Channel OR Chat properties.
- Create and enter a
ChatMessage[]variable for your Output property. - Run the activity.
-
Your input property values are sent to the ListChatMessages or ListChannelMessages API.
-
The API returns the
ChatMessage[]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 Messages |
| Allowed values | Enter a String or String variable. |
| Notes | N/A |
Channel
TeamId
The Id of the Team object that contains the channel you want to get messages from.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes (if ChatId is empty) |
| Default value | Empty |
| Allowed values | Enter a String or String variable. |
| Notes | To get the Team.Id value, use an external process or activity that includes the Team.Id value in its output (for example, Get Teams or external API call) Either (ChatId) or (TeamId and ChannelId) are required. |
ChannelId
The Id of the Channel object that you want to get the message from.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes (if TeamId has a value) |
| Default value | Empty |
| Allowed values | Enter a String or String variable. |
| Notes | To get the Channel.Id value, use an external process or activity that includes the Channel.Id value in its output (for example, Get Channels or external API call) Either (ChatId) or (TeamId and ChannelId) are required. |
Chat
ChatId
The Id of the Chat object that you want to get the messages from.
| Attributes | Details |
|---|---|
| Type | String |
| Required | Yes (if TeamId and ChannelId are empty) |
| 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) Either (ChatId) or (TeamId and ChannelId) are required. |
Options
Limit
The maximum number of recent messages to retrieve.
| Attributes | Details |
|---|---|
| Type | Int32 |
| Required | Yes |
| Default value | Empty |
| Allowed values | Enter a Int32 or Int32 variable. |
| Notes | N/A |
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
Messages
An array of messages (ChatMessage[] object) from the specified a chat or channel.
| Attributes | Details |
|---|---|
| Type |
|
| Required | No (required if you plan to use the output data in subsequent activities) |
| Default value | Empty |
| Allowed values | Enter a ChatMessage[] variable. |
| Notes |
|
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.
