获取聊天

概述

“获取聊天”活动调用 Microsoft Graph “获取聊天” API 来检索指定聊天 ( ChatId ) 的属性。

检索聊天内容后，该活动将在Chat对象 (聊天)中返回其属性，您可以在后续活动（例如， “获取消息” 、 “发送消息”）中将其用作输入变量。

“获取聊天”活动会返回用户所属的聊天列表 ( Chat[] )，而“获取聊天”活动会使用提供的 “聊天ID”检索单个指定的聊天 ( Chat )。如果您没有聊天 ID ，则可以使用“获取聊天”活动来获取相同的聊天属性。

工作方式

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

1. 完成设置步骤。
2. 将“Microsoft Teams 作用域”活动添加到您的项目。
3. 添加活动或运行输出Chat.Id值（例如，获取聊天）的外部流程。
4. 在“Microsoft Teams 作用域”活动中添加“获取聊天”活动。
5. 为“输入”属性输入一个值。
6. 为“输出”属性创建并输入Chat变量。
7. 运行活动。

   • 您的输入属性值将发送到GetChat API。

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

     

属性

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

常见

显示名称

活动的显示名称。

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

输入

ChatId

要检索的聊天 ID。

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

其他

私有

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

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

输出

聊天

表示检索到的聊天的 Chat 对象。

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

示例

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

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