Локальный API платформы WhatsApp Business

WhatsApp Business Platform > On-Premises API > Reference

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

Настройки

/v1/settings

Узел settings можно использовать для настройки клиента WhatsApp Business API, профиля компании, собственного профиля, групп и аккаунта, а также для резервного копирования и восстановления данных. Можно настроить следующие параметры: настройки приложения, настройки профиля, настройки профиля компании, резервное копирование и восстановление, а также двухшаговую проверку.

Границы контекста

С этим узлом связаны следующие границы контекста:

Граница контекста	Описание
`/application`	Изменение, получение или сброс настроек приложения клиента WhatsApp Business API.
`/profile`	Изменение или получение настроек профиля.
`/business/profile`	Настройка следующих параметров профиля компании: адрес компании, ее описание, электронный адрес для связи, отрасль и адрес сайта.
`/business/compliance_info`	Предоставление и получение информации о соблюдении компанией требований электронной коммерции.
`/backup` и `/restore`	Резервное копирование и восстановление информации, в том числе настроек и регистрации приложений.
`/account/two-step`	Использование двухшаговой проверки в качестве дополнительной меры безопасности для клиента WhatsApp Business API.

Прежде чем начать

Для доступа к настройкам требуется аккаунт уровня admin.

Вызовы API

Вызов	Назначение	Возвращаемый результат
`PATCH /v1/settings/application`	Обновление нескольких настроек приложения.	Без объекта `application` (полезных данных).
`GET /v1/settings/application`	Получение всех настроек приложения.	Объект `application`, содержащий имена и значения всех настроек приложения, которые можно задавать.
`DELETE /v1/settings/application`	Сброс всех настроек приложения.	Без объекта `application` (полезных данных).
`POST /v1/settings/business/profile`	Обновление профиля компании.	Без объекта `profile` компании (полезных данных).
`GET /v1/settings/business/profile`	Получение настроек профиля компании.	Объект `profile` компании с адресом, описанием, электронным адресом, указанием отрасли и ссылками на сайты.
`PATCH /v1/settings/profile/about`	Обновление текста профиля компании (информации о компании).	Без объекта `about` профиля (полезных данных).
`GET /v1/settings/profile/about`	Получение текста параметра `about` профиля.	Объект `about` профиля с текстовым содержимым профиля (информацией о компании).
`POST /v1/settings/profile/photo`	Обновление фото профиля.	Без объекта полезных данных.
`GET /v1/settings/profile/photo`	Получение фото профиля.	Содержимое в виде двоичного изображения.
`POST /v1/settings/account/two-step`	Включение двухшаговой проверки.	Без объекта полезных данных.
`DELETE /v1/settings/account/two-step`	Отключение двухшаговой проверки.	Без объекта полезных данных.
`POST /v1/settings/backup`	Экспорт или резервное копирование данных.	Объект `settings` с зашифрованной резервной копией `data`.
`POST /v1/settings/restore`	Импорт или восстановление данных.	Без объекта полезных данных.
`GET /v1/settings/business/compliance_info`	Получение информации о соблюдении компанией требований электронной коммерции.	Без объекта полезных данных.
`POST /v1/settings/business/compliance_info`	Предоставление информации о соблюдении компанией требований электронной коммерции.	Объект `legal_entity_details`.