# Get message replies

> The **Get Message Replies** activity calls the Microsoft Graph [ListChannelMessageReplies](https://docs.microsoft.com/en-us/graph/api/channel-list-messagereplies?view=graph-rest-beta&tabs=http) API to retrieve all message replies from a specified channel (**ChannelId**) and team (**TeamID**).

## Overview

The **Get Message Replies** activity calls the Microsoft Graph [ListChannelMessageReplies](https://docs.microsoft.com/en-us/graph/api/channel-list-messagereplies?view=graph-rest-beta&tabs=http) API to retrieve all message replies from a specified channel (**ChannelId**) and team (**TeamID**).

After performing the search, the activity outputs the properties in a `ChatMessage[]` object (**MessageReplies**) that you can use as input variables in subsequent activities (for example, `ChatMessage(0).Id` in [Get Message Replies](https://docs.uipath.com/marketplace/automation-cloud/latest/user-guide/microsoft-teams-get-message-replies#get-message-replies), [Reply To Message](https://docs.uipath.com/marketplace/automation-cloud/latest/user-guide/microsoft-teams-reply-to-message#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 (that is, the activity dependencies and input/output properties) to run time.

1. Complete the [Setup](https://docs.uipath.com/marketplace/automation-cloud/latest/user-guide/microsoft-teams-setup#setup) steps.
2. Add the [Microsoft Teams Scope](https://docs.uipath.com/marketplace/automation-cloud/latest/user-guide/microsoft-teams-scope#microsoft-teams-scope) activity to your project.
3. Add an activity or run an external process that outputs a `Team.Id` value (e.g., [Get Teams](https://docs.uipath.com/marketplace/automation-cloud/latest/user-guide/microsoft-teams-get-teams#get-teams)).
4. Add an activity or external process that outputs a `Channel.Id` value (e.g., [Get Channels](https://docs.uipath.com/marketplace/automation-cloud/latest/user-guide/microsoft-teams-get-channels#get-channels)).
5. Add an activity or run an external process that outputs a `Message.Id` value (e.g., [Get Messages](https://docs.uipath.com/marketplace/automation-cloud/latest/user-guide/microsoft-teams-get-messages#get-messages)).
6. Add the **Get Message Replies** activity inside the **Microsoft Teams Scope** activity.
7. Enter values for the [Channel](https://docs.uipath.com/marketplace/automation-cloud/latest/user-guide/microsoft-teams-get-message-replies#channel) properties.
8. Create and enter a `ChatMessage[]` variable for your [Output](https://docs.uipath.com/marketplace/automation-cloud/latest/user-guide/microsoft-teams-get-message-replies#output) property.
9. Run the activity.
   * Your input property values are sent to the [ListChannelMessageReplies](https://docs.microsoft.com/en-us/graph/api/channel-list-messagereplies?view=graph-rest-beta&tabs=http) API.
   * The API returns the `ChatMessage[]` value to your output property variable.

     ![docs image](https://dev-assets.cms.uipath.com/assets/images/marketplace/marketplace-docs-image-33561-bf1e687c-9aa4d461.webp)

## Properties

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

![docs image](https://dev-assets.cms.uipath.com/assets/images/marketplace/marketplace-docs-image-35346-1dd13329-28eb0071.webp)

### Common

#### DisplayName

The display name of the activity.

| Attributes | Details |
| --- | --- |
| **Type** | `String` |
| **Required** | Yes |
| **Default value** | *Get Message Replies* |
| **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 message replies 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](https://docs.uipath.com/marketplace/automation-cloud/latest/user-guide/microsoft-teams-get-teams#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 replies 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](https://docs.uipath.com/marketplace/automation-cloud/latest/user-guide/microsoft-teams-get-channels#get-channels) or external API call)  Either (**ChatId**) or (**TeamId and ChannelId**) are required. |

### Message

#### 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 message replies (`ChatMessage[]` object) from the specified a chat or channel.

 <colgroup>
  <col/>
  <col/>
 </colgroup>
 
  
     Attributes  
     Details  
  
 
 
  
    Type 
    <code>ChatMessage[]</code> 
  
  
    Required 
     No (required if you plan to use the output data in subsequent activities)  
  
  
    Default value 
     Empty  
  
  
    Allowed values 
    Enter a <code>ChatMessage[]</code> variable. 
  
  
    Notes 
   
      
         The variable you create for this property can be used as an input variable in subsequent activities (e.g., <code>ChatMessage(0).Id</code> 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., myReplies(0) ).  
         The <code>ChatMessage</code> 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 <code>ChatMessage</code> object (e.g., <code>ODatatType</code> ). For a list of the applicable <code>Team</code> 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](https://docs.uipath.com/marketplace/automation-cloud/latest/user-guide/microsoft-teams-quickstarts) guides.

![docs image](https://dev-assets.cms.uipath.com/assets/images/marketplace/marketplace-docs-image-34391-8f351f04-f77e1890.webp)
