Backup e restauração

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

Use os pontos de extremidade /v1/settings/backup e /v1/settings/restore para facilitar o acesso a diferentes ambientes ou servidores e fazer a restauração a um estado funcional conhecido. Recomendamos que você faça o backup esporadicamente. Assim, caso o servidor ou o cliente da WhatsApp Business API fiquem fora do ar, será possível retomar o trabalho.

O cliente da WhatsApp Business API é compatível com o backup e a restauração de todas as informações necessárias, incluindo configurações e registros de apps.

Atualização de segurança

Na versão v2.31.4, o WhatsApp fixou os pontos de extremidade de backup e restauração para que eles mantenham a consistência com as funcionalidades de backup e restauração de outros clientes do WhatsApp (por exemplo, apps para smartphone). Com essa alteração, um novo código de segurança será gerado para a conta comercial do WhatsApp e os contatos depois de uma operação de restauração bem-sucedida.

Depois da restauração de uma conta comercial do WhatsApp baseada no backup, o cliente consumidor receberá o seguinte aviso (se tiver ativado a configuração "notificação de segurança"): “Seu código de segurança com {Business Account} foi alterado. Toque para saber mais”. Todos os outros comportamentos de backup/restauração continuam os mesmos.

Antes de começar

É preciso usar a conta admin para acessar o backup e restaurar configurações.

Como fazer backup

Só será possível fazer backup/exportar se o cliente da WhatsApp Business API for registrado e estiver em execução. O backup não abrange mensagens ou retornos de chamada. Além disso, não é possível fazer e restaurar capturas instantâneas de máquina virtual.

Exemplo

Para fazer backup, use o ponto de extremidade /v1/settings/backup com o campo password.

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

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

Parâmetros

Parâmetros de solicitação:

Parâmetros de resposta:

Como restaurar

A restauração pode ser usada para configurar uma nova versão do cliente da WhatsApp Business API em uma máquina nova ou para restaurar o aplicativo a um estado funcional conhecido na máquina com as mesmas informações de criptografia e definições de uma configuração anterior.

Para configurar o aplicativo em uma nova máquina, o Coreapp precisa ser executado, porém não registrado. Após a importação, o Coreapp será inicializado automaticamente e começará a exibir solicitações. Se houver um aplicativo na máquina quando a restauração for feita, ele será interrompido. Nesse caso, você precisará inicializá-lo novamente com o comando docker restart.

Ao restaurar uma configuração de multiconexão, o processo deverá sobrepor o mesmo tipo de configuração que está sendo restaurado. Por exemplo, caso você tenha feito backup de uma configuração com dois fragmentos em execução, será necessário ter dois fragmentos em execução para a restauração.

Exemplo

Para restaurar configurações, use o ponto de extremidade /v1/settings/restore com os campos password e data.

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

O cliente da WhatsApp Business API será encerrado após a importação. Em determinadas implantações (por exemplo, da AWS), o aplicativo será reiniciado automaticamente. Caso contrário, será preciso reiniciar o serviço por meio do comando docker restart.

Se for bem-sucedida, a solicitação retornará o código de status HTTP 200 OK, bem como null ou {}. Se houver algum erro, consulte Mensagens de erro e status.

Parâmetros