聊天资源类型

命名空间：microsoft.graph

重要

Microsoft Graph版本下的 /beta API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

聊天是一个或多个参与者之间的 chatMessage 的 集合。 参与者可以是用户或应用。

注意：如果聊天与 onlineMeeting 实例相关联，则列出的一些方法将暂时影响会议。

方法

方法	返回类型	说明
聊天管理
列出聊天	聊天 集合	获取用户所属的聊天列表。
创建聊天	聊天	创建新聊天。
获取聊天	聊天	读取聊天的属性和关系。
更新聊天	聊天	更新聊天的属性。
列出聊天成员	conversationMember 集合	获取聊天中所有用户的列表。
添加聊天成员	位置标头	将用户添加到聊天。
获取聊天成员	conversationMember	获取聊天中的单个用户。
删除聊天成员	无	从聊天中删除用户。
获取用户和应用之间的聊天	聊天	在用户和应用之间进行一对一聊天。
将聊天标记为已读	无	将聊天标记为用户读取。
将聊天标记为未读	无	将聊天标记为用户未读。
隐藏聊天	无	隐藏用户的聊天。
取消隐藏聊天	无	取消隐藏用户的聊天。
邮件
列出聊天中的消息	chatMessage	在聊天中获取消息。
获取聊天中的消息	chatMessage	获取聊天中的单个消息。
为用户在所有聊天中获取消息	聊天 集合	从用户参与的所有聊天中获取消息。
应用
列出聊天中的应用	teamsAppInstallation 集合	列出聊天 (和关联会议) 中安装的应用。
在聊天中获取应用	teamsAppInstallation	获取聊天 (和关联会议) 中安装的特定应用。
在聊天中添加应用		在聊天 (和关联会议) 中添加 (安装) 应用。
在聊天中升级应用	无	更新到聊天 (和关联会议) 中安装的最新版本的应用。
从聊天中卸载应用	无	从聊天 (和关联会议) 中删除 (卸载) 应用。
List permission grants	resourceSpecificPermissionGrant 集合	列出已授予此聊天中的应用的权限。
选项卡
聊天中的列表选项卡	teamsTab	固定到聊天 (和关联会议) 的列表选项卡。
获取聊天中的选项卡	teamsTab	获取固定到聊天 (和关联会议) 的特定选项卡。
向聊天添加选项卡	teamsTab	将 (固定) 选项卡添加到聊天 (和关联会议) 。
聊天中的“更新”选项卡	teamsTab	更新聊天 (和关联会议) 中选项卡的属性。
从聊天中删除选项卡	无	从聊天 (和关联会议) 中删除 (取消固定) 选项卡。
操作
列出聊天操作	teamsAsyncOperation 集合	获取在聊天中运行或正在运行的异步操作的列表。
获取聊天操作	teamsAsyncOperation	获取在聊天中运行或正在运行的单个异步操作。
固定的消息
列出固定的消息	pinnedChatMessageInfo 集合	获取聊天中固定消息的列表。
固定消息	pinnedChatMessageInfo	在聊天中固定聊天消息。
取消固定消息	无	取消固定聊天中的消息。

注意： 使用应用程序权限时，请确保知道如何获取聊天 ID。 由于不支持列出具有应用程序权限的聊天，因此并非所有方案都是可能的。 可以获取具有委派权限的聊天 ID，也可以从具有应用程序权限的 /chats/getAllMessage 的更改通知 中获取聊天 ID。

属性

属性	类型	说明
chatType	chatType	指定聊天的类型。 可能的值是：group、oneOnOne、meeting、unknownFutureValue。
createdDateTime	dateTimeOffset	创建聊天的日期和时间。 只读。
id	String	聊天的唯一标识符。 只读。
lastUpdatedDateTime	dateTimeOffset	聊天重命名或成员列表上次更改的日期和时间。 只读。
onlineMeetingInfo	teamworkOnlineMeetingInfo	表示有关联机会议的详细信息。 如果聊天未与联机会议关联，则该属性为空。 只读。
tenantId	String	在其中创建聊天的租户的标识符。 只读。
topic	String	(聊天的可选) 主题或主题。 仅可用于群聊。
观点	chatViewpoint	表示有关聊天的特定于调用方的信息，例如上次消息读取日期和时间。 仅当在委派上下文中发出请求时，才会填充此属性。
webUrl	String	Microsoft Teams 中聊天的 URL。 URL 应被视为不透明的 Blob，而不是分析的。 只读。

chatType 值

成员	值	说明
oneOnOne	0	指示聊天是 1：1 聊天。 对于这种类型的聊天，名册大小是固定的;无法删除/添加成员。
组	1	指示聊天是群组聊天。 可以更新至少两个人) 的名册大小 (此类型的聊天。 可以稍后删除/添加成员。
会议	2	指示聊天与联机会议相关联。 这种类型的聊天仅在创建联机会议时创建。
unknownFutureValue	3	可变枚举 sentinel 值。 请勿使用。

关系

关系	类型	说明
installedApps	teamsAppInstallation 集合	聊天中所有应用的集合。 可为 NULL。
lastMessagePreview	chatMessageInfo	聊天中发送的最后一条消息的预览。 如果聊天中未发送任何消息，则为 Null。 目前，只有 列表聊天 操作支持此属性。
members	conversationMember 集合	聊天中所有成员的集合。 可为 Null。
messages	chatMessage 集合	聊天中所有消息的集合。 可为 NULL。
operations	teamsAsyncOperation 集合	在聊天中运行或正在运行的所有 Teams 异步操作的集合。 可为 NULL。
permissionGrants	resourceSpecificPermissionGrant 集合	授予聊天应用的权限的集合。
pinnedMessages	pinnedChatMessageInfo 集合	聊天中所有固定消息的集合。 可为 NULL。
选项卡	teamsTab 集合	聊天中所有选项卡的集合。 可为 Null。

JSON 表示形式

下面是资源的 JSON 表示形式。

{
  "id": "string (identifier)",
  "topic": "string",
  "createdDateTime": "dateTimeOffset",
  "lastUpdatedDateTime": "dateTimeOffset",
  "chatType": "string",
  "webUrl": "string",
  "tenantId": "string",
  "viewpoint": {
    "@odata.type": "microsoft.graph.chatViewpoint"
  },
  "onlineMeetingInfo": {
    "@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"
  }
}

另请参阅

• channel
• chatMessage