Get Chat

Overview

The Get Chat activity calls the Microsoft Graph GetChat API to retrieve the properties of a specified chat (ChatId).

After retrieving the chat, the activity returns its properties in a Chat object (Chat) that you can use as an input variable in subsequent activities (e.g., Get Messages, Send Message, etc.).

Unlike the Get Chats activity, which returns a list of chats the user is a member of (Chat[]), the Get Chat activity retrieves a single, specified chat (Chat) using the provided ChatId. If you don't have the ChatId, you can use the Get Chats activity to get the same chat properties.

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. Add an activity or run an external process that outputs a Chat.Id value (e.g., Get Chats).
4. Add the Get Chat activity inside the Microsoft Teams Scope activity.
5. Enter a value for the Input property.
6. Create and enter a Chat variable for your Output property.

7. Run the activity.

   • Your input property values are sent to the GetChat API.
   • The API returns the Chat 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
Allowed values	Enter a String or String variable.
Notes	N/A

Input

ChatId

The Id of the chat that you want to retrieve.

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 (e.g., 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

Chat

The Chat object that represents the retrieved chat.

Attributes	Details
Type	Chat
Required	No (required if you plan to use the output data in subsequent activities)
Default value	Empty
Allowed values	Enter a Chat variable.
Notes	The variable you create for this property can be used as an input variable in subsequent activities (e.g., Get Messages, Send Message, etc.). The Chat object includes multiple properties and 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 Chat 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.