通过

聊天资源类型

  • 项目

命名空间：microsoft.graph

重要

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

表示一个聊天，该聊天是一个或多个参与者之间的 chatMessages 集合。 参与者可以是用户或应用。

注意：如果聊天与 onlineMeeting 实例相关联，列出的某些方法会传递影响会议。

方法

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

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

属性

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

chatType 值

成员 说明
oneOnOne 指示聊天是一对一聊天。 此类型的聊天的名单大小是固定的;无法删除/添加成员。
组 指示聊天是群组聊天。 可针对此类聊天更新至少两人的名单大小 () 。 稍后可以删除/添加成员。
会议 指示聊天与联机会议相关联。 此类聊天仅在创建联机会议过程中创建。
unknownFutureValue 可演变枚举 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 表示形式显示了资源类型。

{
  "chatType": "String",
  "createdBy": {"@odata.type": "microsoft.graph.identitySet"},
  "createdDateTime": "String (timestamp)",
  "id": "string (identifier)",
  "isHiddenForAllMembers": "Boolean",
  "lastUpdatedDateTime": "String (timestamp)",  
  "onlineMeetingInfo": {
    "@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"
  },
  "tenantId": "String",  
  "topic": "String",
  "viewpoint": {
    "@odata.type": "microsoft.graph.chatViewpoint"
  },
  "webUrl": "String"
}

相关内容