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

Узел health

/v1/health

Используйте узел health , чтобы проверить статус клиента WhatsApp Business API.

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

Узел health поддерживает маркер Bearer и аутентификацию ключей API.

Ключи API

If you wish to monitor the health, metrics, and stats nodes from an orchestrator, Bearer tokens are not the best option for ongoing checks as they expire every 7 days. To mediate this, you can use an API key, which can be set using the WA_API_KEY environment variable in the waweb environment section in the .yml file of your installation setup. 
services:
...
  waweb:
  ...
    environment:
    ...
    WA_API_KEY: your-api-key-token
The API key you set must have a minimum of 12 characters and a maximum of 128 characters. The Webapp must be restarted whenever you change the API key.

Ограничения

Ключ API должен иметь длину от 12 до 128 символов.

Получение

Для уточнения статуса своего клиента WhatsApp Business API выполните запрос GET к этому узлу.

Пример

Запрос:

GET /v1/health
{
  Authorization: Bearer your-auth-token | Apikey your-api-key-token
}

В ответе указывается статус работоспособности шлюза сервера WhatsApp. Если заголовок Authorization отсутствует или недействителен, будет возвращена ошибка 401 .

Один экземпляр

{
    "health": {
       "gateway_status": "connected | connecting | disconnected | uninitialized | unregistered"
    }
}

Повышенная доступность и распределение нагрузки

{
    "health": {
      "your-hostname1:your-container-id1": {
          "gateway_status": "connected | connecting | disconnected | uninitialized | unregistered",
          "role": "primary_master | secondary_master | coreapp"
      },
      "your-hostname2:your-container-id2": {
          "gateway_status": "connected | connecting | disconnected | uninitialized | unregistered",
          "role": "primary_master | secondary_master | coreapp"
      },
    }
}

В режиме повышенной доступности к серверу WhatsApp будет подключен только один узел Coreapp. Для остальных узлов, включая главный основной, параметр gateway_status будет иметь значение disconnected. В режиме распределения нагрузки с использованием X сегментов к серверу WhatsApp будут подключены X узлов Coreapp и главный основной узел.

Параметры

ИмяОписание

health

Тип: объект

Содержит поля, описывающие работоспособность клиента WhatsApp Business API.

gateway_status

Тип: строка

Статус соединения между узлом Coreapp и серверами WhatsApp.


Поддерживаемые значения:

  • connected, connecting — система работает исправно.
  • uninitialized — возможно, приложение обновляет или инициализирует схему базы данных. Повторите попытку через несколько минут. Если статус не изменяется, обратитесь в службу поддержки WhatsApp.
  • unregistered — необходимо зарегистрировать клиент WhatsApp Business API. Дополнительную информацию см. в документации по регистрации.
  • disconnected — узел Coreapp не подключен к серверам WhatsApp.

role

Тип: строка

Роль контейнера в конфигурациях с повышенной доступностью и распределением нагрузки. Подробные сведения об этих конфигурациях см. в документации по доступности и масштабированию.


Поддерживаемые значения: primary_master, secondary_master, coreapp