聊天资源类型

命名空间:microsoft.graph

重要

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

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

注意:如果聊天与 onlineMeeting 实例关联,则列出的一些方法将可传递影响会议。

方法

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

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

属性

属性 类型 说明
chatType chatType 指定聊天类型。 可取值为:grouponeOnOnemeetingunknownFutureValue
createdDateTime dateTimeOffset 创建聊天的日期和时间。 只读。
id String 聊天的唯一标识符。 只读。
lastUpdatedDateTime dateTimeOffset 上次更改聊天的日期和时间或成员列表。 只读。
onlineMeetingInfo teamworkOnlineMeetingInfo 表示有关联机会议的详细信息。 如果聊天未与联机会议关联,则属性为空。 只读。
tenantId 字符串 创建聊天的租户的标识符。 只读。
topic String (聊天) 主题或主题。 仅适用于群聊。
一个 chatViewpoint 表示有关聊天的特定于呼叫者的信息,例如上次消息读取日期和时间。 只有在委托上下文中提出请求时,才填充此属性。
webUrl String 聊天中聊天的 URL Microsoft Teams。 URL 应视为不透明的 blob,而不是解析的。 只读。

chatType 值

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

关系

关系 类型 说明
installedApps teamsAppInstallation 集合 聊天中所有应用的集合。 可为 Null。
members conversationMember 集合 聊天中所有成员的集合。 可为 Null。
messages chatMessage 集合 聊天中所有消息的集合。 可为 NULL。
permissionGrants resourceSpecificPermissionGrant 集合 授予聊天应用的权限集合。
operations teamsAsyncOperation 集合 在聊天中Teams运行或运行的异步操作的所有异步操作的集合。 可为空。
lastMessagePreview chatMessageInfo 预览聊天中发送的最后一条消息。 如果聊天中未发送任何消息,则其为 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"
  }
}

另请参阅