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 (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.

1. Complete the Setup steps.
2. Add the Microsoft Teams Scope activity to your project.
3. 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 (e.g.,Get Teams) AND an activity or external process that outputs a Channel.Id value (e.g., Get Channels).

1. Add the Get Messages activity inside the Microsoft Teams Scope activity.
2. Enter values for the Channel OR Chat properties.
3. Create and enter a ChatMessage[] variable for your Output property.

4. 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 (e.g., 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 (e.g., 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 (e.g., 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	ChatMessage[]
Required	No (required if you plan to use the output data in subsequent activities)
Default value	Empty
Allowed values	Enter a ChatMessage[] variable.
Notes	The variable you create for this property can be used as an input variable in subsequent activities (e.g., ChatMessage(0).Id in Get Message Replies, Reply To Message, etc.). * When using this variable as an input property value, specify the item in the array that you want to use (e.g., myMessages(0)). The ChatMessage object includes multiple properties that you can use in other activities.The example image below shows some of the properties that you can return. Note - some properties listed in the designer are not applicable to the ChatMessage object (e.g., ODatatType). For a list of the applicable Team properties, visit the links above.

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.