Sauvegarde et restauration

/v1/settings/backup et /v1/settings/restore

Utilisez les points de terminaison /v1/settings/backup et /v1/settings/restore pour faciliter les migrations vers d’autres environnements ou serveurs, et la restauration vers un état de fonctionnement connu. Nous vous recommandons d’effectuer des sauvegardes occasionnelles afin de faciliter la restauration de votre client ou serveur doté de l’API WhatsApp Business s’il tombait en panne.

Le client de l’API WhatsApp Business prend en charge la sauvegarde et la restauration de toutes les informations nécessaires, notamment les paramètres et l’enregistrement de l’application.

Mise à jour de sécurité

Dans WhatsApp v2.31.4, les points de terminaison de sauvegarde et de restauration ont été corrigés afin d’utiliser le même modèle de sécurité que les fonctionnalités de sauvegarde et de restauration d’autres clients WhatsApp (comme les applications des téléphones). Suite à ce changement, un nouveau code de sécurité est généré entre votre compte WhatsApp Business et ses contacts après une opération de restauration réussie.

Le client recevra alors la notification suivante : « Votre code de sécurité pour {Business Account} a changé. Appuyez pour en savoir plus. » s’il a activé le paramètre « Notification de sécurité ». Aucun autre aspect de la fonctionnalité de sauvegarde/restauration n’a été modifié.

Avant de commencer

Vous devez utiliser le compte admin pour accéder aux paramètres de sauvegarde et de restauration.

Sauvegarde

La possibilité de sauvegarder/d’exporter ne s’exécute qu’après que le client de l’API WhatsApp Business a été enregistré et exécuté. La sauvegarde n’intègre pas les messages ou les rappels, et les instantanés de machines virtuelles et leur restauration ne fonctionnent pas.

Exemple

Pour sauvegarder, utilisez le point de terminaison /v1/settings/backup associé au champ password.

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

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

Paramètres

Paramètres de la requête :

Paramètres de la réponse :

Restauration

La restauration permet de configurer une nouvelle version du client de l’API WhatsApp Business sur une nouvelle machine ou de restaurer l’application à un état de fonctionnement connu sur la même machine avec les mêmes informations et paramètres de chiffrement qu’une configuration antérieure.

Pour configurer l’application sur une nouvelle machine, il est nécessaire que la Coreapp soit en cours d’exécution, mais pas enregistrée. Une fois l’importation réussie, la Coreapp s’initialise automatiquement et commence à répondre aux requêtes. Si la machine a une application existante et que vous effectuez une restauration, l’application s’arrête et vous devez la relancer avec la commande docker restart.

Lorsque vous restaurez une configuration Multiconnect, vous devez effectuer la restauration sur le même type d’installation que celui à partir duquel vous effectuez la restauration. Par exemple, si vous avez sauvegardé une configuration avec deux partitions en cours d’exécution, vous devez disposer de deux partitions en cours d’exécution pour la restauration.

Exemple

Pour restaurer des paramètres, utilisez le point de terminaison /v1/settings/restore associé aux champs password et data.

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

Le client de l’API WhatsApp Business se ferme à la fin de l’importation. Dans certains déploiements (comme AWS), l’application redémarre automatiquement. Sinon, vous devez redémarrer le service à l’aide de la commande docker restart.

En cas de réussite, la réponse renvoyée comprend le code d’état HTTP 200 OK, et null ou {}. Si une erreur se produit, consultez les messages d’erreur et de statut.

Paramètres