Перейти к содержанию

Получение уведомлений через HTTP API#

Получать входящие уведомления (сообщения, статусы) можно через HTTP API запросы по аналогии, как реализованы остальные методы API мессенджера MAX.
При этом гарантируется хронологический порядок следования уведомлений в той последовательности, в которой они были получены FIFO.

Все входящие уведомления сохраняются в очереди и ожидают своего получения в течение 24 часов.

Для получения входящих уведомлений требуется выполнить последовательно вызов двух методов:

  • Метод ReceiveNotification выполняет получение входящего уведомления.
  • Метод DeleteNotification подтверждает успешное получение и обработку уведомления.

Настройка инстанса#

Перед получением входящих уведомлений требуется выполнить настройку инстанса.

Настройка инстанса может быть выполнена программно с использованием метода SetSettings, либо интерактивно в интерфейсе личного кабинета.

Настройка методом SetSettings#

Для настройки получения входящих уведомлений по технологии HTTP API необходимо оставить пустым параметр webhookUrl.
Также необходимо указать, какие виды уведомлений необходимо получать.

Пример тела запроса метода SetSettings#

{
    "webhookUrl": "",
    "outgoingWebhook": "yes",
    "stateWebhook": "yes",
    "incomingWebhook": "yes"
}

Настройка в личном кабинете#

  1. Перейдите в Личный кабинет
  2. Выберите инстанс, на котором необходимо изменить настройки
  3. Нажмите кнопку Изменить на панели инстанса
  4. Активируйте переключатели по необходимым видам уведомлений
  5. Нажмите на кнопку Сохранить изменения для применения настроек.

Получение входящих уведомлений#

После выполнения настройки инстанса можно приступать к получению уведомлений методами ReceiveNotification и DeleteNotification.

Подробное описание формата входящих уведомлений представлено в разделе Формат входящих уведомлений.