备份和还原

/v1/settings/backup 和 /v1/settings/restore

使用 /v1/settings/backup 和 /v1/settings/restore 端点可更轻松地移至不同的环境或服务器，并还原为已知的工作状态。我们建议您不时备份数据，这样即使 WhatsApp Business API 客户端或服务器停止工作，您也可以轻松自己的数据。

WhatsApp Business API 客户端支持备份和还原所有必要信息，包括应用设置和注册。

安全更新

在 v2.31.4 中，WhatsApp 修复了备份和还原端点，使这些端点与其他 WhatsApp 客户端（如手机应用）的备份和还原功能的安全模式一致。在此更新后，如果还原操作成功，系统将在 WhatsApp Business 商业帐号及其联系人之间生成新的安全码。

从备份中还原 WhatsApp Business 商业帐号后，如果消费者客户启用了“安全通知”设置，他们将收到通知“您的 {Business Account} 安全码已更改。点击了解更多。”所有其他备份或还原行为与之前相同。

准备工作

您必须使用 admin 帐户访问备份和还原设置。

备份

只有已注册 WhatsApp Business API 客户端，并且该客户端正在运行时，才能运行备份或导出功能。备份操作不会备份消息或回调，不会拍摄虚拟机快照，也无法还原此类快照。

示例

如要备份，请使用包含 password 字段的 /v1/settings/backup 端点。

POST /v1/settings/backup
{
    "password": "PASSWORD"
}

{
    "settings": {
       "data": "ENCRYPTED_BACKUP_DATA"
    }
}

参数

请求参数：

响应参数：

还原

还原功能可以用于在新设备上设置 WhatsApp Business API 客户端的新版本，或者在同一台设备上借助之前安装的相同加密信息和设置，将应用程序还原为已知的工作状态。

在新设备上设置应用程序时，必须运行核心应用，但无需注册。成功导入数据后，核心应用会自动初始化并开始处理请求。如果设备已经安装了应用程序，您要进行还原操作，则现有应用程序会停止运行，而且您必须使用 docker restart 命令重启该应用程序。

在还原多连接设置时，您需要以正在还原的相同设置类型为基础进行还原。例如，如果要备份正在运行两个分片的设置，您必须运行两个分片以执行还原操作。

示例

如要还原设置，请使用包含 password 和 data 字段的 /v1/settings/restore 端点。

POST /v1/settings/restore
{
    "password": "your-password",
    "data": "your-encrypted-backup-data"
}

导入后，WhatsApp Business API 客户端将关闭。在某些部署（例如 AWS）中，应用程序会自动重启。而在其他情况下，您必须使用 docker restart 命令重启服务。

如果请求成功，系统会返回 HTTP 状态代码 200 OK 以及 null 或 {}。如果遇到任何错误，请参阅错误和状态消息。

参数