迁移

如果您拥有 WhatsApp Business API 客户端(带有数据库)的现有设置数据,并想使用相同的手机号将客户端和数据库一并迁移至新设置,请参阅本文档,以了解如何确定需要作出的更改及相应操作。

准备工作

  • 备份是迁移过程中最重要的步骤。
  • 您无需在迁移后重新注册手机号。迁移完成后,您便可立即开始发送消息。
  • 新设置与旧设置必须拥有相同的分片数。您无法在迁移期间增加或减少分片数。如果您为旧设置配置了 X 个 Master 和 Y 个核心应用,则新设置必须拥有完全相同的 Master 与核心应用数量。如果 Master 与核心应用的数量在迁移前后有所不同,则迁移将会失败。
  • 请先尝试迁移测试帐户,然后再迁移生产环境帐户。
  • 迁移期间会出现停机状况。停机时长视迁移选项而定,但每个迁移选项均会出现停机状况。

迁移选项

根据您要迁移的数据量,有多个迁移选项可供选择。请选择最符合您需求的选项。

为每个迁移选项保留的数据

选项 1选项 2选项 3

设置

应用设置

注册

加密密钥

消息

消息

回调

联系人

身份验证口令

API 用户数据

API 身份验证口令

每个迁移选项的典型用例与停机时间

我们将在此表格中介绍每个迁移选项的典型用例,以及相应的停机时间。这些只是典型用例,您可按需自行选择迁移选项的类型。

通用用例停机时间

选项 1

由解决方案供应商将终端客户端移至您的平台,并且只保留设置数据

由于需要在机器间传输最少的数据,因此相较于其他选项,此选项的停机时间最短。

选项 2

由解决方案供应商将终端客户端移至您的平台,并同时保留设置与消息数据

由于需要在机器间传输消息与设置数据,因此相较于选项 1,此选项的停机时间较长。数据规模可能会因不同业务而变得十分庞大。

选项 3

由 WhatsApp 的直接客户自行管理 WhatsApp Business API 客户端,并且您想将 WhatsApp Business API 客户端和数据移至不同机器上

由于需要在机器间传输所有数据,因此相较于其他选项,此选项的停机时间最长。数据规模可能会因不同业务而变得十分庞大。

选项 1:仅迁移设置

若选择仅迁移设置,则系统只会备份和恢复设置信息。系统不会迁移消息和身份验证口令信息。

第 1 步:安装新设置

请使用安装文档来设置新的 WhatsApp Business API 客户端。

第 2 步:为新设置获取新的身份验证口令

当前的身份验证口令在新环境中将不再有效。登录新设置,以获取新的身份验证口令。

第 3 步:清除

  • [可选] 禁用双重验证。当您忘记双重验证码并需要重新注册时,此选项将大有用处。虽然您在迁移顺利时无需重新注册,但也可能会出现强制您重新注册的情况,例如备份和恢复过程因某些未知原因而失败。请按照禁用双重验证代码的说明进行操作。
    请注意:如果您确信双重验证代码准确无误,则可跳过此步骤。
  • [可选] 重置 Webhooks。如果您已通过设置 Webhooks 来接收入站通知,并打算在迁移期间更改 Webhook 服务器,请在应用程序设置中禁用旧版 Webhook 服务器。
    请注意:如果您不打算在迁移后更改 Webhook 服务器,则可跳过此步骤。

第 4 步:备份当前设置中的设置数据

使用当前的身份验证口令来备份当前 WhatsApp Business API 客户端中的设置数据。

第 5 步:卸载当前设置

这会导致收发消息时出现停机情况。为尽量缩短停机时间,请确保 WhatsApp Business API 客户端已作好在新环境中运行的准备。如需了解详细说明,请参阅相应安装指南的卸载版块。请确保只卸载 WhatsApp Business API 客户端(包括核心应用、网页应用和 Master 的 Docker 容器);请勿删除数据库

第 6 步:在新设置中恢复设置

登录(如果您尚未使用新的身份验证口令),并在新设置中执行恢复操作。
您的新 WhatsApp Business API 客户端应能运行全部所需信息,并已作好收发消息的准备。请谨记,如果您已正确地备份和恢复设置,则需重新注册 WhatsApp 帐户。

第 7 步:执行运行状况检查

执行运行状况检查,并发送测试消息,以验证 WhatsApp Business API 客户端能否正常运行。

第 8 步:[可选] 启用双重认证

如果您已在第 3 步中禁用此功能,则现在请重新启用双重验证。此功能可为您的 WhatsApp 帐号提供额外保护。

第 9 步:设置 Webhooks

设置 Webhooks,以启用入站通知

第 10 步:删除旧数据库

旧数据库中包含您的旧设置、旧消息及旧的身份验证口令数据。如果您想在日后恢复其中的任何数据,则请勿删除旧数据库。一旦您决定删除该数据库,则请确保 WhatsApp Business API 客户端已至少运行 14 天,而且消息功能可正常运作,然后方可将其删除。

选项 2:迁移设置和消息

若您选择迁移设置和消息,则系统会同时备份并恢复设置信息和消息。系统并不会迁移身份验证口令。

请留意需传输至另一部机器的数据量。由于系统需备份和恢复更多数据,因此相较于选项 1,其相应的停机时间也会更长。总停机时间视需传输的数据量和网络延迟而定。

第 1 步:清除

  • [可选] 禁用双重验证。当您忘记双重验证码并需要重新注册时,此选项将大有用处。虽然您在迁移顺利时无需重新注册,但也可能会出现强制您重新注册的情况,例如备份和恢复过程因某些未知原因而失败。请按照禁用双重验证代码的说明进行操作。
    请注意:如果您确信双重验证代码准确无误,则可跳过此步骤。
  • [可选] 重置 Webhooks。如果您已通过设置 Webhooks 来接收入站通知,并打算在迁移期间更改 Webhook 服务器,请在应用程序设置中禁用旧版 Webhook 服务器。这是在收发消息功能开始遭遇停机情况时,我们应采取的第一步。
    请注意:如果您不打算在迁移后更改 Webhook 服务器,则可跳过此步骤。

第 2 步:卸载当前设置

这会导致收发消息时出现停机情况。为尽量缩短停机时间,请确保 WhatsApp Business API 客户端已作好在新环境中运行的准备。如需了解详细说明,请参阅相应安装指南的卸载版块。请确保只卸载 WhatsApp Business API 客户端;请勿删除数据库

第 3 步:备份数据库

使用当前 WhatsApp Business API 客户端中的公用代码(如 mysqldumppg_dump),备份waweb(此数据库包含用户/身份验证数据)以外的所有数据库。
请注意:如果您是解决方案供应商并打算将业务迁移至平台(或从平台中迁出),请务必将 waweb 排除在外。您也可不沿用或传输当前的已存储身份验证口令和用户信息。

第 4 步:恢复数据库

使用公用代码(如 mysqldumppg_dump),在新版 WhatsApp Business API 客户端中恢复数据库。

第 5 步:安装新设置

请使用安装文档来设置新的 WhatsApp Business API 客户端。请务必将数据库放在第 4 步中的恢复位置。

第 6 步:为新设置获取新的身份验证口令

当前的身份验证口令在新环境中将不再有效。登录新设置,以获取新的身份验证口令。
您的新 WhatsApp Business API 客户端应能运行全部所需信息,并已作好收发消息的准备。请谨记,如果您已正确地备份和恢复资料库,则无需重新注册 WhatsApp 帐户。

第 7 步:执行运行状况检查

执行运行状况检查,并发送测试消息,以验证 WhatsApp Business API 客户端能否正常运行。

第 8 步:[可选] 启用双重认证

如果您已在第 1 步中禁用此功能,则现在请重新启用双重验证。此功能可为您的 WhatsApp 帐号提供额外保护。

第 9 步:设置 Webhooks

设置 Webhooks,以启用入站通知

第 10 步:删除旧数据库

旧数据库中包含您的旧设置、旧消息及旧的身份验证口令数据。如果您想在日后恢复这些数据,则请勿删除旧资料库。一旦您决定删除该数据库,则请确保 WhatsApp Business API 客户端已至少运行 14 天,而且消息功能可正常运作,然后方可将其删除。

选项 3:全部迁移

若您选择全部迁移,则系统会备份和恢复所有设置、消息和身份验证口令。

此选项似乎是最佳方案,但请留意需传输至另一部机器的数据量。由于系统需备份和恢复更多数据,因此相较于选项 1选项 2,其相应的停机时间也会更长。

第 1 步:清除

  • [可选] 禁用双重验证。当您忘记双重验证码并需要重新注册时,此选项将大有用处。虽然您在迁移顺利时无需重新注册,但也可能会出现强制您重新注册的情况,例如备份和恢复过程因某些未知原因而失败。请按照禁用双重验证代码的说明进行操作。
    请注意:如果您确信双重验证代码准确无误,则可跳过此步骤。

第 2 步:备份当前的身份验证口令

口令的最长有效期为 7 天。在您执行迁移操作前,请确保口令仍然有效。

第 3 步:卸载当前设置

这会导致收发消息时出现停机情况。为尽量缩短停机时间,请确保 WhatsApp Business API 客户端已作好在新环境中运行的准备。如需了解详细说明,请参阅相应安装指南的卸载版块。请确保只卸载 WhatsApp Business API 客户端;请勿删除数据库

第 4 步:[可选] 备份数据库

请使用可捕获设置、消息和身份验证口令数据的公用代码 (如 mysqldumppg_dump),以备份数据库。
请注意:如果您只想迁移 WhatsApp Business API 客户端(不包括数据库),则可跳过此步骤。

第 5 步:恢复数据库

使用公用代码(如 mysqldumppg_dump),在新版 WhatsApp Business API 客户端中恢复数据库。

第 6 步:安装新设置

请使用安装文档来设置新的 WhatsApp Business API 客户端。请务必将数据库放在第 5 步中的恢复位置。
您的新 WhatsApp Business API 客户端应能运行全部所需信息,并已作好收发消息的准备。请谨记,如果您已正确地备份和恢复数据,则无需重新注册 WhatsApp 帐户。

第 7 步:执行运行状况检查

执行运行状况检查,并发送测试消息,以验证 WhatsApp Business API 客户端能否正常运行。

第 8 步:[可选] 启用双重认证

如果您已在第 1 步中禁用此功能,则现在请重新启用双重验证。此功能可为您的 WhatsApp 帐号提供额外保护。

第 9 步:设置 Webhooks

设置 Webhooks,以启用入站通知

第 10 步:删除旧数据库

旧数据库中包含您的旧设置、旧消息及旧的身份验证口令数据。如果您想在日后恢复这些数据,则请勿删除旧资料库。一旦您决定删除该数据库,则请确保 WhatsApp Business API 客户端已至少运行 14 天,而且消息功能可正常运作,然后方可将其删除。