命名空间:microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用,请使用 版本 选择器。
表示一个或多个参与者之间的 chatMessage 集合的聊天。 参与者可以是用户或应用。
注意: 如果聊天与 onlineMeeting 实例关联,则列出的一些方法会可传递影响会议。
方法
| 方法 | 返回类型 | 说明 |
|---|---|---|
| 对话助手管理 | ||
| List | 聊天 集锦 | 获取用户所属聊天的列表。 |
| 创建 | 聊天 | 创建新聊天。 |
| Get | 聊天 | 读取聊天的属性和关系。 |
| 更新 | 聊天 | 更新聊天的属性。 |
| 删除 | 无 | 删除聊天。 |
| 删除用户的所有访问权限 | 无 | 删除用户对聊天的访问权限。 |
| List members | conversationMember 集合 | 获取聊天中所有用户的列表。 |
| 添加成员 | 位置标头 | 将用户添加到聊天。 |
| 获取成员 | conversationMember | 获取聊天中的单个用户。 |
| 删除成员 | 无 | 从聊天中删除用户。 |
| 获取用户和应用之间的聊天 | 聊天 | 在用户和应用之间进行一对一聊天。 |
| 将聊天标记为已读 | 无 | 为用户将聊天标记为已读。 |
| 将聊天标记为“未读” | 无 | 为用户将聊天标记为未读。 |
| 隐藏聊天 | 无 | 隐藏用户聊天。 |
| 取消隐藏聊天 | 无 | 取消隐藏用户聊天。 |
| 开始迁移 | 聊天 | 通过在现有 聊天中启用迁移模式来开始外部消息的迁移。 |
| 完成迁移 | 聊天 | 通过从 聊天中删除迁移模式,完成外部消息的迁移。 |
| 邮件 | ||
| 列出聊天中的消息 | chatMessage | 在聊天中获取消息。 |
| 获取消息回复 | chatMessage | 获取聊天中的单个消息。 |
| 在所有聊天中获取消息 | 聊天 集锦 | 从用户参与的所有聊天中获取消息。 |
| 获取所有聊天中的保留消息 | chatMessage 集合 | 从用户参与的所有聊天中获取所有保留的消息,包括一对一聊天、群组聊天和会议聊天。 |
| 获取用户的增量聊天消息 | chatMessage 集合 | 从用户参与的所有聊天中获取消息列表,包括一对一聊天、群组聊天和会议聊天。 |
| 应用 | ||
| 列出聊天中的应用 | teamsAppInstallation 集合 | 列出聊天 (中安装的应用和关联的会议) 。 |
| 在聊天中安装应用 | teamsAppInstallation | 在聊天 (和关联的会议) 中安装特定应用。 |
| 在聊天中添加应用 | 在聊天 (和关联的会议) 中添加 (安装) 应用。 | |
| 升级聊天中安装的应用 | 无 | 更新到聊天 (和关联会议) 中安装的应用的最新版本。 |
| 从聊天中删除应用 | 无 | 从聊天 (和关联的会议) 中删除 (卸载) 应用。 |
| List permission grants | resourceSpecificPermissionGrant 集合 | 列出此聊天中授予应用的权限。 |
| 选项卡 | ||
| 列出聊天中的选项卡 | teamsTab | 列出固定到聊天 (的选项卡和关联的会议) 。 |
| 在聊天中获取选项卡 | teamsTab | 获取固定到聊天 (和关联会议) 的特定选项卡。 |
| 向聊天添加选项卡 | teamsTab | 将选项卡) (固定添加到聊天 (和关联的会议) 。 |
| 聊天中的“更新”选项卡 | teamsTab | 更新聊天 (和关联会议) 中选项卡的属性。 |
| 从聊天中删除选项卡 | 无 | 从聊天 (和关联的会议) 中删除 (取消固定) 选项卡。 |
| 操作 | ||
| 列举操作 | teamsAsyncOperation 集合 | 获取聊天上运行或正在运行的异步操作的列表。 |
| 在聊天中获取操作 | teamsAsyncOperation | 获取在聊天上运行或正在运行的单个异步操作。 |
| 已固定邮件 | ||
| 列出已固定邮件 | pinnedChatMessageInfo 集合 | 获取聊天中固定消息的列表。 |
| 固定消息 | pinnedChatMessageInfo | 在聊天中固定聊天消息。 |
| 取消固定消息 | 无 | 取消固定聊天中的消息。 |
注意: 使用应用程序权限时,请确保知道如何获取聊天 ID。 由于不支持列出具有应用程序权限的聊天,因此并非所有方案都可行。 可以获取具有委派权限的聊天 ID,以及从具有应用程序权限的 /chats/getAllMessages 的更改通知 中获取 ID。
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| chatType | chatType | 指定聊天的类型。 可能的值包括 group、oneOnOne、meeting、unknownFutureValue。 |
| createdBy | identitySet | 创建聊天的用户或应用程序。 只读。 |
| createdDateTime | dateTimeOffset | 创建聊天的日期和时间。 只读。 |
| id | String | 聊天的唯一标识符。 只读。 |
| isHiddenForAllMembers | 布尔值 | 指示是否对所有成员隐藏聊天。 只读。 |
| lastUpdatedDateTime | dateTimeOffset | 重命名聊天或上次更改成员列表的日期和时间。 只读。 |
| migrationMode | migrationMode | 指示聊天是否处于迁移模式。 此值适用于 null 从未进入迁移模式的聊天。 可能的值包括 inProgress、completed、unknownFutureValue。 |
| onlineMeetingInfo | teamworkOnlineMeetingInfo | 表示有关联机会议的详细信息。 如果聊天未与联机会议关联,则属性为空。 只读。 |
| originalCreatedDateTime | dateTimeOffset | 聊天的原始创建时间的时间戳。 该值是 null 聊天从未进入迁移模式。 |
| tenantId | String | 在其中创建聊天的租户的标识符。 只读。 |
| topic | String | (可选) 聊天的主题或主题。 仅适用于群组聊天。 |
| 视点 | chatViewpoint | 表示有关聊天的特定于呼叫方的信息,例如上次消息读取日期和时间。 仅当在委派上下文中发出请求时,才填充此属性。 |
| webUrl | String | Microsoft Teams 中聊天的 URL。 URL 应被视为不透明的 blob,而不进行分析。 只读。 |
chatType 值
| 成员 | 说明 |
|---|---|
| oneOnOne | 指示聊天是 1:1 聊天。 此类聊天的名单大小是固定的;无法删除/添加成员。 |
| 组 | 指示聊天是群聊。 可针对此类聊天更新至少两人的名册大小 () 。 稍后可以删除/添加成员。 |
| 会议 | 指示聊天与联机会议相关联。 此类聊天仅作为创建联机会议的一部分创建。 |
| unknownFutureValue | 可进化枚举哨兵值。 请勿使用。 |
migrationMode 值
| 成员 | 说明 |
|---|---|
| inProgress | 对话助手已进入迁移模式。 |
| completed | 对话助手已退出迁移模式。 |
| unknownFutureValue | 可进化枚举哨兵值。 请勿使用。 |
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| installedApps | teamsAppInstallation 集合 | 聊天中所有应用的集合。 可为 Null。 |
| lastMessagePreview | chatMessageInfo | 聊天中发送的最后一条消息的预览。
Null 如果聊天中未发送任何消息。 目前,只有 列表聊天 操作支持此属性。 |
| members | conversationMember 集合 | 聊天中所有成员的集合。 可为 Null。 |
| messages | chatMessage 集合 | 聊天中所有消息的集合。 可为 NULL。 |
| operations | teamsAsyncOperation 集合 | 聊天中运行或正在运行的所有 Teams 异步操作的集合。 可为 NULL。 |
| permissionGrants | resourceSpecificPermissionGrant 集合 | 授予应用聊天权限的集合。 |
| pinnedMessages | pinnedChatMessageInfo 集合 | 聊天中所有固定消息的集合。 可为 NULL。 |
| 选项卡 | teamsTab 集合 | 聊天中所有选项卡的集合。 可为 Null。 |
| targetedMessages | targetedChatMessage 集合 | 聊天中仅对特定用户可见的目标消息的集合。 可为 Null。 不能使用 $expand展开此关系。 还可通过 userTeamwork: getAllTargetedMessages API 检索目标消息。 |
JSON 表示形式
以下 JSON 表示形式显示资源类型。
{
"chatType": "String",
"createdBy": {"@odata.type": "microsoft.graph.identitySet"},
"createdDateTime": "String (timestamp)",
"id": "String (identifier)",
"isHiddenForAllMembers": "Boolean",
"lastUpdatedDateTime": "String (timestamp)",
"migrationMode": "String",
"onlineMeetingInfo": {"@odata.type": "microsoft.graph.teamworkOnlineMeetingInfo"},
"originalCreatedDateTime": "String (timestamp)",
"tenantId": "String",
"topic": "String",
"viewpoint": {"@odata.type": "microsoft.graph.chatViewpoint"},
"webUrl": "String"
}