Copia de seguridad y restauración

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

Usa los extremos /v1/settings/backup y /v1/settings/restore para facilitar el movimiento a otros entornos o servidores y la restauración a un estado de funcionamiento conocido. Recomendamos hacer copias de seguridad de forma ocasional para poder recuperar fácilmente el servidor o el cliente de la API de WhatsApp Business en caso de interrupción.

El cliente de la API de WhatsApp Business admite las copias de seguridad y la restauración de toda la información necesaria, incluidos el registro y la configuración de la aplicación.

Actualización de seguridad

En la versión v2.31.4, WhatsApp ha corregido los extremos de copia de seguridad y restauración para que sean coherentes con el modelo de seguridad de la funcionalidad de copia de seguridad y restauración de otros clientes de WhatsApp (es decir, aplicaciones para teléfonos). Con este cambio, se genera un nuevo código de seguridad entre la cuenta empresarial de WhatsApp y sus contactos tras una operación de restauración realizada correctamente.

Cuando una cuenta empresarial de WhatsApp se restaura a partir de una copia de seguridad, el cliente consumidor recibirá el aviso que se indica a continuación: “Tu código de seguridad con {Business Account} ha cambiado. Toca para obtener más información”. Todos los demás comportamientos de copia de seguridad o restauración permanecen igual que antes.

Antes de empezar

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

Copia de seguridad

La capacidad de realizar copias de seguridad o exportaciones solo se ejecuta cuando el cliente de la API de WhatsApp Business se ha registrado y está en funcionamiento. La copia de seguridad no incluye mensajes ni devoluciones de llamada. Asimismo, la captura de instantáneas de las máquinas virtuales y su restauración no funcionan.

Ejemplo

Para hacer una copia de seguridad, usa el extremo /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 la respuesta:

Restauración

La restauración se puede usar para configurar una nueva versión del cliente de la API de WhatsApp Business en una máquina nueva o restaurar la aplicación a un estado de funcionamiento conocido en la misma máquina con la misma configuración e información de cifrado de un paso anterior.

Para configurar la aplicación en una máquina nueva, la aplicación principal debe estar en funcionamiento, pero no registrada. Una vez realizada correctamente la importación, la aplicación principal se inicializa de forma automática y empieza a atender solicitudes. Si la máquina tiene una aplicación existente y llevas a cabo una restauración, la aplicación se detiene y debes iniciarla de nuevo mediante el comando docker restart.

Al restaurar una configuración de conexión múltiple, la configuración de origen y destino de la restauración deben ser del mismo tipo. Por ejemplo, si has realizado una copia de seguridad de una configuración con dos particiones en ejecución, debes tener dos particiones en ejecución para llevar a cabo la restauración.

Ejemplo

Para restaurar una configuración, usa el extremo /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 cierra tras la importación. En algunas implementaciones (p. ej., AWS), la aplicación se reinicia automáticamente. De lo contrario, tienes que reiniciar el servicio mediante el comando docker restart.

Una solicitud correcta devuelve el código de estado HTTP 200 OK y null o {}. Si experimentas algún error, consulta la página de mensajes de error y de estado.

Parámetros