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 (e.g., ChatMessage(0).Id
in Get Message Replies, Reply To Message, etc.).
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 aChat.Id
value (e.g., Get Chats).
B. Add an activity or run an external process that outputs aTeam.Id
value (e.g.,Get Teams) AND an activity or external process that outputs aChannel.Id
value (e.g., 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 |
|
Required | Yes |
Default value | Get Messages |
Allowed values | Enter a |
Notes | N/A |
Channel
TeamId
The Id of the Team
object that contains the channel you want to get messages from.
Attributes | Details |
---|---|
Type |
|
Required | Yes (if ChatId is empty) |
Default value | Empty |
Allowed values | Enter a |
Notes | To get the |
ChannelId
The Id of the Channel
object that you want to get the message from.
Attributes | Details |
---|---|
Type |
|
Required | Yes (if TeamId has a value) |
Default value | Empty |
Allowed values | Enter a |
Notes | To get the |
Chat
ChatId
The Id of the Chat
object that you want to get the messages from.
Attributes | Details |
---|---|
Type |
|
Required | Yes (if TeamId and ChannelId are empty) |
Default value | Empty |
Allowed values | Enter a |
Notes | To get the |
Options
Limit
The maximum number of recent messages to retrieve.
Attributes | Details |
---|---|
Type |
|
Required | Yes |
Default value | Empty |
Allowed values | Enter a |
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 |
Notes | The variable you create for this property can be used as an input variable in subsequent activities (e.g.,
|
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