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

Получение уведомлений через HTTP API (рекомендуется)#

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

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

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

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

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

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

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

https://webhook.green-api.com

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

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

{
    "webhookUrl": "https://webhook.green-api.com",
    "outgoingWebhook": "yes",
    "stateWebhook": "yes",
    "incomingWebhook": "yes",
    "deviceWebhook": "no"
}

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

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

Настройки входящих уведомлений

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

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

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