Резервное копирование и восстановление

/v1/settings/backup и /v1/settings/restore

Конечные точки /v1/settings/backup и /v1/settings/restore упрощают переход на новые рабочие среды или серверы и восстановление определенного рабочего состояния. Мы рекомендуем периодически проводить резервное копирование, чтобы в случае сбоя в работе клиента или сервера WhatsApp Business API вы смогли легко восстановить его.

Клиент WhatsApp Business API поддерживает резервное копирование и восстановление всей необходимой информации, включая настройки и регистрацию приложений.

Обновление для системы безопасности

В версии v2.31.4 WhatsApp в конечные точки резервного копирования и восстановления внесены изменения, чтобы привести их в соответствие с моделью безопасности соответствующих функций других клиентов WhatsApp (т. е. приложений для телефонов). Теперь, когда это изменение реализовано, после успешного восстановления данных генерируется новый код безопасности между бизнес-аккаунтом WhatsApp и его контактами.

После восстановления бизнес-аккаунта WhatsApp из резервной копии клиент пользователя получит уведомление об изменении кода безопасности с соответствующим бизнес-аккаунтом и ссылкой на дополнительные сведения, если на этом клиенте включены уведомления о безопасности. Все прочие функции резервного копирования и восстановления работают так же, как раньше.

Перед началом работы

Для доступа к настройкам резервного копирования и восстановления следует использовать аккаунт admin.

Резервное копирование

Функции резервного копирования и экспорта работают только после регистрации и запуска клиента WhatsApp Business API. Резервные копии сообщений и обратных вызовов не создаются, а создание снимков данных виртуальных машин и их восстановление не работает.

Пример

Для резервного копирования используйте конечную точку /v1/settings/backup с полем password.

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

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

Параметры

Параметры запроса:

Параметры ответа:

Восстановление

Функция восстановления позволяет настроить новую версию клиента WhatsApp Business API на новом компьютере либо восстановить рабочее состояние приложения на том же компьютере с прежними параметрами шифрования и другими настройками.

Для настройки приложения на новом компьютере компонент Coreapp должен быть запущен, но не зарегистрирован. После успешного импорта Coreapp автоматически инициализируется и начинает обслуживать запросы. Если на компьютере уже есть приложение и вы пытаетесь его восстановить, оно останавливает работу, и вам потребуется снова запустить его с помощью команды docker restart.

Восстановление конфигурации с распределением нагрузки следует выполнять на конфигурации того же типа, из которой производится восстановление. Например, если вы создали резервную копию конфигурации с двумя сегментами, для восстановления должно быть также запущено два сегмента.

Пример

Для восстановления настроек используйте конечную точку /v1/settings/restore с полями password и data.

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

После импорта клиент API WhatsApp Business завершает работу. На определенных платформах (например, AWS) приложение перезапускается автоматически. В противном случае его потребуется перезапустить командой docker restart.

В случае успеха возвращается код статуса HTTP 200 OK и значение null или {}. В случае возникновения ошибок обратитесь к этому разделу.

Параметры