聊天: startMigration

命名空间:microsoft.graph

重要

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

通过在现有 聊天中启用迁移模式来开始外部消息的迁移。 导入操作仅限于新创建的处于空状态的标准通道。 有关详细信息,请参阅 使用 Microsoft Graph 将第三方平台消息导入 Teams。

可以为内容迁移定义一个最小时间戳,以便导入过去的邮件。 指定的时间戳必须早于聊天的当前 createdDateTime。 导入的内容始终受目标线程的 createdDateTime 的限制。 有效负载中的可选 createdDateTime 属性允许您更新此值,但具有严格的规则:

  • createdDateTime 只能向过去移动。
  • createdDateTime 不能更新为比当前 createdDateTime 更新的值。

注意

  • 调用 startMigration 的应用程序端到端拥有迁移会话。 同一应用程序必须为同一线程调用 import message 和 completeMigration 。 在拥有的应用程序完成迁移之前,任何其他应用程序都不能在线程上调用这些 API。
  • 聊天进入迁移模式后,Teams 客户端中将显示一个横幅,指示对话处于导入模式。 在 completeMigration 完成迁移之前,此横幅将保持可见。

此 API 支持以下通道类型。

实体 子类型 迁移模式支持 注释
聊天 分组,1:1 新的和现有的 不支持会议聊天。 支持外部成员。

注意:

  • 初始导入中不允许使用聊天类型。
  • 支持联合聊天,但用户无法创建联合资源。 例如,他们无法代表联合用户导入消息,目标聊天必须属于发起程序应用的租户。 用户只能将内容导入到向其进行身份验证的租户中。

API 可用性

此 API 可用于以下国家级云部署。

全局服务 美国政府 L4 美国政府 L5 (DOD) 由世纪互联运营的中国
✅ ❌ ❌ ❌

权限

为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。

权限类型 最低特权权限 更高特权权限
委派(工作或学校帐户) 不支持。 不支持。
委派(个人 Microsoft 帐户) 不支持。 不支持。
应用程序 Teamwork.Migrate.All 不可用。

HTTP 请求

POST /chats/{chat-id}/startMigration

请求标头

标头 值
Authorization 持有者 {token}。 必填。 详细了解 身份验证和授权。
Content-Type application/json. 可选

请求正文

在请求正文中,提供以下参数的 JSON 表示形式。

参数 类型 说明
conversationCreationDateTime DateTimeOffset 要迁移的消息的最小时间戳。 时间戳必须早于聊天的当前 createdDateTime 。 如果未提供,则使用当前日期和时间。 可选。

响应

如果成功,此方法返回 204 No Content 响应代码。 它不会返回响应正文中的任何内容。

示例

示例 1:在聊天中开始迁移

下面的示例演示如何在聊天中启动迁移。

请求

以下示例显示了一个请求。

POST https://graph.microsoft.com/beta/chats/19:4b6bed8d24574f6a9e436813cb2617d8@thread.tacv2/startMigration

响应

以下示例显示了相应的响应。

HTTP/1.1 204 No Content

示例 2:当聊天已处于迁移模式时开始迁移

下面的示例显示了当聊天已处于迁移模式时如何开始迁移。 此请求失败,但没有响应 400 Bad Request 。

请求

以下示例显示了一个请求。

POST https://graph.microsoft.com/beta/chats/19:4b6bed8d24574f6a9e436813cb2617d8@thread.tacv2/startMigration

响应

以下示例显示了相应的响应。

HTTP/1.1 400 Bad Request