Backup und Wiederherstellung

/v1/settings/backup und /v1/settings/restore

Durch Verwendung der Endpunkte /v1/settings/backup und /v1/settings/restore kannst du einfacher zu anderen Umgebungen oder Servern wechseln und sie in einem bekanntermaßen funktionierenden Zustand wiederherstellen. Du solltest regelmäßige Sicherungen durchführen, damit du sie im Falle eines Ausfalls deines WhatsApp Business API-Clients oder -Servers ohne Weiteres wiederherstellen kannst.

Der WhatsApp Business API-Client unterstützt das Sichern und Wiederherstellen sämtlicher erforderlicher Informationen, einschließlich App-App-Einstellungen und -Registrierung.

Sicherheitsupdate

In v2.31.4 hat WhatsApp die Backup- und Wiederherstellungsendpunkte korrigiert, um sie mit dem Sicherheitsmodell der Backup- und Wiederherstellungsfunktionalität anderer WhatsApp-Clients (d. h. mobiler Apps) in Einklang zu bringen. Mit dieser Änderung wird nach einem erfolgreichen Wiederherstellungsvorgang zwischen deinem WhatsApp-Unternehmenskonto und dessen Kontakten ein neuer Sicherheitscode generiert.

Nachdem ein WhatsApp-Unternehmenskonto aus einem Backup wiederherstellt wurde, erhält der Konsument den folgenden Hinweis: „Dein Sicherheitscode für {Business Account} wurde geändert. Tippe hier, um mehr zu erfahren. Voraussetzung ist, dass die Einstellung für „Sicherheitsbenachrichtigungen“ aktiviert ist. Alle anderen Verhaltensweisen für Backups/Wiederherstellungen bleiben unverändert.

Bevor du beginnst

Du musst das admin-Konto verwenden, um auf die Einstellungen zur Sicherung und Wiederherstellung zuzugreifen.

Sicherung

Daten können erst gesichert/exportiert werden, wenn der WhatsApp Business API-Client registriert wurde und ausgeführt wird. Die Sicherung sichert weder Nachrichten noch Callbacks. Zudem funktioniert das Erstellen von Snapshots virtueller Computer und deren Wiederherstellung nicht.

Beispiel

Verwende zur Sicherung den Endpunkt /v1/settings/backup mit dem Feld password.

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

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

Parameter

Anfrageparameter:

Antwortparameter:

Wiederherstellung

Die Wiederherstellung kann verwendet werden, um eine neue Version des WhatsApp Business API-Clients auf einem neuen Computer einzurichten oder um die App in einem bekanntermaßen funktionierenden Zustand auf demselben Computer mit denselben Verschlüsselungsinformationen und -einstellungen eines vorherigen Schritts wiederherzustellen.

Um die App auf einem neuen Computer einzurichten, muss die Coreapp ausgeführt werden, jedoch nicht registriert sein. Nach dem erfolgreichen Import initialisiert sich die Coreapp automatisch selbst und beginnt damit, Anfragen bereitzustellen. Wenn auf dem Gerät eine App vorhanden ist und du diese wiederherstellst, wird die App angehalten. Anschließend musst du sie mit dem Befehl docker restart neu starten.

Bei der Wiederherstellung einer Einrichtung von Multiconnect musst du die Wiederherstellung zusätzlich im selben Einrichtungstyp durchführen, über die du die Wiederherstellung vornimmst. Wenn du beispielsweise eine Einrichtung mit zwei ausgeführten Shards gesichert hast, musst du für die Wiederherstellung zwei Shards ausführen.

Beispiel

Verwende zum Wiederherstellen der Einstellungen den Endpunkt /v1/settings/restore mit den Feldern password und data.

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

Der WhatsApp Business API-Client wird nach dem Import heruntergefahren. In bestimmten Bereitstellungen (z. B. AWS) startet die App automatisch neu. Andernfalls musst du den Service mit dem Befehl docker restart neu starten.

Eine erfolgreiche Anfrage gibt den HTTP-Statuscode 200 OK und entweder null oder {} zurück. Wenn Fehler auftreten, findest du weitere Informationen unter Fehlercodes und Statusmeldungen.

Parameter