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

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

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

Срок хранения входящих уведомлений составляет 24 часа.

Видеоинструкция

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

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

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

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

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

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

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

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

Настройку получения входящих уведомлений можно также выполнить интерактивно. Для этого перейдите в Личный кабинет и выберите требуемый инстанс. Будут отображены текущее состояние инстанса и настройки для получения входящих уведомлений. Что бы поменять настройки необходимо нажать кнопку изменить на панели инстанса. Текущие настройки можно будет поменять на панели уведомлений см. рис. Укажите значение параметра webhookUrl, а также переключатели по видам уведомлений. Нажмите на кнопку "Сохранить изменения" для применения настроек.

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

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

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