UiPath Marketplace 用户指南

上次更新日期 2024年9月5日

获取消息

获取消息 活动调用 Microsoft Graph 列表聊天消息或列表频道消息 API

检索指定聊天 (ChatId) 或频道 (ChannelId) 和团队 (TeamID) 中的所有消息。

执行搜索后，该活动会在 ChatMessage[] 对象 (消息) 中输出属性，您可以在后续活动中将其用作输入变量（例如，获取消息回复、回复消息等中的ChatMessage(0).Id ）。

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

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

B. 添加活动或运行输出 Team.Id 值的外部流程（例如，获取团队）以及输出 Channel.Id 值的活动或外部流程（例如，获取渠道）。

在 Microsoft Teams 作用域 活动中添加 获取消息 活动。
输入“频道或聊天”属性的值。
为“ 输出 ”属性创建并输入 ChatMessage[] 变量。
运行活动。
- 您的输入属性值将发送到 ListChatMessages 或 List ChannelMessages API。
- API 会将 ChatMessage[] 值返回到您的输出属性变量。

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

活动的显示名称。

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

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

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

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

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

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

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

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

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

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