获取消息

使用“获取消息”活动从 Microsoft Teams 聊天或频道中检索所有消息。

概述

获取消息活动调用 Microsoft Graph列出聊天消息或列出频道消息API，以从指定的聊天 ( ChatId ) 或频道 ( ChannelId ) 和团队 ( TeamID ) 检索所有消息。

执行搜索后，活动将在ChatMessage[]对象（ “消息 ” ）中输出属性，您可以在后续活动中将这些属性用作输入变量（例如， “获取消息回复”和“回复消息”中的ChatMessage(0).Id ，依此类推）。

工作方式

以下步骤和消息序列图是活动从设计时（即活动依赖项和输入/输出属性）到运行时如何工作的示例。

1. 完成设置步骤。
2. 将“Microsoft Teams 作用域”活动添加到您的项目。
3. Complete one of the following two options (A or B):

添加活动或运行输出Chat.Id值（例如，获取聊天）的外部流程。

B.添加一个活动或运行输出Team.Id值（例如，获取团队）的活动或外部流程，并且添加一个输出Channel.Id值（例如，获取频道）的活动或外部流程（例如，获取频道）。

1. 在“Microsoft Teams 作用域”活动中添加“获取消息”活动。
2. 输入“频道”或“聊天”属性的值。
3. 为“输出”属性创建并输入ChatMessage[]变量。
4. 运行活动。

   • 您的输入属性值将发送到列出聊天消息API 或列出频道消息API。

   • API 会将 ChatMessage[] 值返回到您的输出属性变量。

     

属性

将此活动添加到 UiPath Studio 中的项目时，会指定以下属性的值。

常见

显示名称

活动的显示名称。

属性	详细信息
类型	String
必填	是
默认值	获取消息
允许的值	输入 String 或 String 变量。
注意	不适用

频道

团队 ID

包含要从中获取消息的频道的 Team 对象的 ID。

属性	详细信息
类型	String
必填	是（如果聊天 ID为空）
默认值	空白
允许的值	输入 String 或 String 变量。
注意	要获取Team.Id值，请使用在其输出中包含Team.Id值的外部流程或活动（例如，获取团队或外部 API 调用），(聊天 ID ) 或（团队 ID 和频道 ID ) 为必需。

频道 ID

要从中获取消息的 Channel 对象的 ID。

属性	详细信息
类型	String
必填	是（如果团队 ID具有一个值）
默认值	空白
允许的值	输入 String 或 String 变量。
注意	要获取Channel.Id值，请使用在其输出（例如，获取渠道）或外部 API 调用中包含Channel.Id值的外部流程或活动。(聊天 ID ) 或（团队 ID 和渠道 ID ) 为必需。

聊天

ChatId

要从中获取消息的 Chat 对象的 ID。

属性	详细信息
类型	String
必填	是（如果“团队 ID”和“频道 ID”为空）
默认值	空白
允许的值	输入 String 或 String 变量。
注意	要获取Chat.Id值，请使用在其输出中包含Chat.Id值的外部流程或活动（例如，获取聊天或外部 API 调用），(聊天 ID ) 或 (团队 ID 和频道 ID ) 为必需。

选项

上限

要检索的最近消息的最大数量。

属性	详细信息
类型	Int32
必填	是
默认值	空白
允许的值	输入 Int32 或 Int32 变量。
注意	不适用

其他

私有

如果已选择，变量和参数的值将不会在 Verbose 级进行记录。

属性	详细信息
类型	复选框
必填	否
默认值	未选中
允许的值	已选择或未选择
注意	不适用

输出

消息

来自指定聊天或频道的消息数组（ ChatMessage[] 对象）。

属性	详细信息
类型	ChatMessage[]
必填	否（如果您计划在后续活动中使用输出数据，则为必填项）
默认值	空白
允许的值	输入ChatMessage[]变量。
注意	您为此属性创建的变量可用作后续活动中的输入变量（例如， “获取消息回复” 、 “回复消息”中的ChatMessage(0).Id ）。 * 当使用此变量作为输入属性值时，请在数组中指定要使用的项目（例如myMessages(0) ）。 ChatMessage对象包含您可以在其他活动中使用的多个属性。下面的示例图显示了您可以返回的一些属性。 注意 - 设计器中列出的某些属性不适用于ChatMessage对象（例如ODatatType ）。有关适用的Team属性的列表，请访问上面的链接。

示例

下图显示了活动依赖关系和输入/输出属性值的示例。

有关分步说明和示例，请参阅快速入门指南。