備份和還原

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

/v1/settings/backup 和 /v1/settings/restore 端點可用來輕鬆移至其他環境或伺服器，以及還原為已知的工作狀態。建議不定期進行備份，如此當 WhatsApp Business API 用戶端或伺服器關閉時，您還能輕鬆將其恢復。

WhatsApp Business API 用戶端支援備份和還原所有必要資訊，包括應用程式設定和註冊。

安全性更新

在 v2.31.4 中，WhatsApp 修復了備份和還原端點，使其能與其他 WhatsApp 用戶端（即手機應用程式）備份和還原功能的安全模式保持一致。透過此變更，在成功還原操作後，您的 WhatsApp 商業帳號與其聯絡人之間便會產生新的安全碼。

WhatsApp 商業帳號透過備份進行還原後，消費者用戶端若已啟用「安全性通知」設定，將會收到「您的 {Business Account} 安全碼已變更。請點擊以瞭解詳情。」的通知。所有其他備份／還原行為仍與之前一樣保持不變。

準備工作

您必須使用 admin 帳號存取備份和還原設定。

備份

備份／匯出功能只有在 WhatsApp Business API 用戶端已註冊且執行中才能執行。備份工作不會備份訊息或回呼，也無法建立虛擬機器暫存版本與還原。

範例

若要備份，請使用具有 password 欄位的 /v1/settings/backup 端點。

POST /v1/settings/backup { "password": "your-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 或 {}。如果遇到任何錯誤，請參閱錯誤和狀態訊息。

參數