Get Messages

Vue d'ensemble (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).

Mode de fonctionnement

Les étapes et le diagramme de séquence de messages suivants illustrent le fonctionnement de l'activité, depuis la conception (c'est-à-dire les dépendances d'activité et les propriétés d'entrée/sortie) jusqu'à l'exécution.

1. Terminez les étapes de Configuration .
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 (for example, Get Teams) AND an activity or external process that outputs a Channel.Id value (for example, 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. Exécutez l’activité.

   • Your input property values are sent to the ListChatMessages or ListChannelMessages API.

   • L'API renvoie la valeur ChatMessage[] à votre variable de propriété de sortie.

     

Propriétés

Les valeurs des propriétés suivantes sont spécifiées lors de l'ajout de cette activité à votre projet dans UiPath Studio.

Commun

DisplayName

Le nom complet de l’activité.

Attributs	Détails (Details)
Saisie de texte	String
Requis	Oui (Yes)
Valeur par défaut	Get Messages
Valeurs autorisées	Saisissez une variable String ou String .
Remarques	S/O

Canal

ID d'équipe

ID de l'objet Team qui contient le canal à partir duquel vous souhaitez recevoir des messages.

Attributs	Détails (Details)
Saisie de texte	String
Requis	Yes (if ChatId is empty)
Valeur par défaut	Vide
Valeurs autorisées	Saisissez une variable String ou String .
Remarques	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.

Identifiant du canal

ID de l'objet Channel à partir duquel vous souhaitez recevoir le message.

Attributs	Détails (Details)
Saisie de texte	String
Requis	Yes (if TeamId has a value)
Valeur par défaut	Vide
Valeurs autorisées	Saisissez une variable String ou String .
Remarques	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.

Messagerie

ChatId

ID de l'objet Chat dont vous souhaitez obtenir les messages.

Attributs	Détails (Details)
Saisie de texte	String
Requis	Yes (if TeamId and ChannelId are empty)
Valeur par défaut	Vide
Valeurs autorisées	Saisissez une variable String ou String .
Remarques	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

Limite

Le nombre maximal de messages récents à récupérer.

Attributs	Détails (Details)
Saisie de texte	Int32
Requis	Oui (Yes)
Valeur par défaut	Vide
Valeurs autorisées	Saisissez une variable Int32 ou Int32 .
Remarques	S/O

Divers

Private

Si elles sont sélectionnées, les valeurs des variables et des arguments ne sont plus enregistrées au niveau détaillé.

Attributs	Détails (Details)
Saisie de texte	Case à cocher
Requis	Non (No)
Valeur par défaut	non sélectionné
Valeurs autorisées	Sélectionné ou Non sélectionné
Remarques	S/O

Sortie

Messages

Tableau de messages (objet ChatMessage[] ) provenant de la conversation ou du canal spécifié.

Attributs	Détails (Details)
Saisie de texte	ChatMessage[]
Requis	Non (requis si vous prévoyez d'utiliser les données de sortie dans des activités ultérieures)
Valeur par défaut	Vide
Valeurs autorisées	Saisissez une variable ChatMessage[] .
Remarques	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.

Exemple

L'image suivante montre un exemple de la relation de dépendance d'activité et des valeurs de propriété d'entrée/sortie.

For step-by-step instructions and examples, see the Quickstart guides.