Backup e ripristino

/v1/settings/backup e /v1/settings/restore

Usa gli endpoint /v1/settings/backup e /v1/settings/restore per semplificare il passaggio ad ambienti o server diversi ed eseguire il ripristino a uno stato di lavoro noto. Ti consigliamo di eseguire periodicamente il backup in modo che, se il tuo client o server dell'API di WhatsApp Business si arresta, puoi ripristinarlo facilmente.

Il client dell'API di WhatsApp Business supporta il backup e il ripristino di tutte le informazioni necessarie, incluse la registrazione e le impostazioni dell'app.

Aggiornamento di sicurezza

Nella v2.31.4 WhatsApp ha corretto gli endpoint di backup e ripristino per renderli coerenti con il modello di sicurezza della funzionalità di backup e ripristino di altri client WhatsApp (vale a dire, app per telefono). Con questa modifica, dopo una corretta operazione di ripristino viene generato un nuovo codice di sicurezza tra l'account WhatsApp Business e i relativi contatti.

Dopo il ripristino di un account WhatsApp Business dal backup, il client del consumatore riceverà l'avviso "Il tuo codice di sicurezza con {Business Account} è cambiato. Tocca per scoprire di più." se l'impostazione "notifica di sicurezza" è abilitata. Tutti gli altri comportamenti di backup/ripristino rimangono invariati.

Prima di iniziare

Devi usare l'account admin per accedere alle impostazioni di backup e ripristino.

Backup

Puoi eseguire il backup/l'esportazione solo dopo che il client dell'API di WhatsApp Business è stato registrato ed è in esecuzione. La procedura di backup non include messaggi o callback e l'acquisizione di snapshot della macchina virtuale e il loro ripristino non funziona.

Esempio

Per eseguire il backup, utilizza l'endpoint /v1/settings/backup con il campo password.

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

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

Parametri

Parametri della richiesta:

Parametri della risposta:

Ripristino

Il ripristino può essere utilizzato per configurare una nuova versione del client dell'API di WhatsApp Business su una nuova macchina o ripristinare l'applicazione a uno stato di lavoro noto sulla stessa macchina con le stesse informazioni di crittografia e le stesse impostazioni di una configurazione precedente.

Per la configurazione dell'app su una nuova macchina, il Coreapp deve essere in esecuzione ma non registrato. Dopo aver eseguito correttamente l'importazione, il Coreapp si inizializza automaticamente e inizia a mostrare le richieste. Se la macchina ha un'app esistente e si esegue un ripristino, l'app si arresta ed è necessario riavviarla con il comando docker restart.

Quando ripristini una configurazione multiconnect, devi eseguire il ripristino sullo stesso tipo di configurazione da cui stai ripristinando. Ad esempio, se hai eseguito il backup di una configurazione con due partizioni in esecuzione, devi avere due partizioni in esecuzione per il ripristino.

Esempio

Per ripristinare le impostazioni, usa l'endpoint /v1/settings/restore con i campi password e data.

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

Il client dell'API di WhatsApp Business si arresta dopo l'importazione. In alcune distribuzioni (ad es., AWS), l'app si riavvia automaticamente. In caso contrario, devi riavviare il servizio con il comando docker restart.

Una richiesta corretta restituisce il codice di stato HTTP 200 OK insieme a null o {}. Se si verificano errori, consulta Messaggi di errore e di stato.

Parametri