Crear copias de seguridad y hacer restauraciones

/v1/settings/backup y /v1/settings/restore

Usa los puntos de conexión /v1/settings/backup y /v1/settings/restore para facilitar el desplazamiento entre distintos entornos o servidores y volver a un estado de funcionamiento conocido. Recomendamos hacer una copia de seguridad de vez en cuando para que, si tu servidor o cliente de la API de WhatsApp Business falla o queda bloqueado, puedas restaurarlo con facilidad.

El cliente de la API de WhatsApp Business admite la creación de copias de seguridad y la restauración de toda la información necesaria, incluida la configuración y el registro de la app:

Actualización de seguridad

En la v2.31.4 WhatsApp ha corregido los puntos de conexión de creación y restauración de copias de seguridad para que sean coherentes con el modelo de seguridad de las funciones de copia de seguridad y restauración de otros clientes de WhatsApp (es decir, las apps de teléfono). Con este cambio, se genera un nuevo código de seguridad entre tu cuenta de WhatsApp para empresas y sus contactos después de una operación de restauración exitosa.

Después de que una cuenta de WhatsApp para empresas se restaura a partir de una copia de seguridad, el cliente consumidor recibirá un aviso "Su código de seguridad de {Cuenta comercial} cambió. Toque para obtener más información". si tiene activada la opción de "notificación de seguridad". Todas las demás funciones de creación y restauración de copias de seguridad funcionan igual que antes.

Antes de empezar

Debes usar la cuenta admin para acceder a la configuración de creación y restauración de copias de seguridad.

Creación de copias de seguridad

Solo se pueden realizar tareas de creación de copias de seguridad/exportación una vez que se haya registrado el cliente de la API de WhatsApp Business y este se encuentre en funcionamiento. La copia de seguridad no guarda mensajes ni devoluciones de llamada, y no funciona tomar capturas de la máquina virtual ni restaurarlas.

Ejemplo:

Para crear una copia de seguridad, usa el punto de conexión /v1/settings/backup con el campo password.

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

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

Parámetros

Parámetros de la solicitud:

Parámetros de respuesta:

Restauración

Puedes utilizar la restauración para configurar una nueva versión del cliente de la API de WhatsApp Business en una nueva máquina o restaurar la app a un estado de funcionamiento conocido en la misma máquina con la misma información de cifrado y los parámetros de una configuración anterior.

Para configurar la app en una nueva máquina, Coreapp debe estar en funcionamiento, pero no debe estar registrada. Una vez importada correctamente, Coreapp se inicializa de forma automática y comienza a servir solicitudes. Si la máquina tiene una app preexistente y realizas una restauración, la app se detendrá y tendrás que volver a iniciarla mediante el comando docker restart.

Al restaurar una configuración de conexión múltiple, deberás hacer la restauración respetando el mismo tipo de configuración a partir del cual realizas la restauración. Por ejemplo, si realizaste una copia de seguridad de una configuración con dos particiones en funcionamiento, para la restauración deberás contar con dos particiones en funcionamiento.

Ejemplo:

Para restaurar la configuración, usa el punto de conexión /v1/settings/restore con los campos password y data.

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

El cliente de la API de WhatsApp Business se desactiva después de la importación. En ciertas implementaciones (por ejemplo, AWS), la aplicación se reinicia de forma automática. De lo contrario, debes reiniciar el servicio mediante el comando docker restart.

Si la solicitud se realiza correctamente, se devuelven el código de estado HTTP 200 OK y null o {}. Si se produce algún error, consulta Mensajes de error y de estado.

Parámetros