備份和還原

/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 和 {} 的其中一項。如果遇到任何錯誤，請參閱錯誤和狀態訊息。

參數