Статус сокета инстанса#
Входящее уведомление данного типа содержит данные о состоянии сокета (готов или нет инстанс отправлять/принимать сообщения)
Настройка инстанса
Чтобы получать входящие уведомления о сообщениях с геолокацией, необходимо включить настройки одним из представленных вариантов:
-
Через личный кабинет включить настройку
Получать уведомления об изменении состояния авторизации аккаунта
-
Через метод SetSettings включить настройку
stateWebhook
Уведомление#
Формат уведомления#
Параметр | Тип | Описание |
---|---|---|
typeWebhook | string | Тип входящего уведомления. Для уведомлений данного типа поле принимает значение statusInstanceChanged |
instanceData | object | Данные об инстансе |
timestamp | integer | Время наступления события в UNIX-формате |
statusInstance | string | Состояние инстанса. Принимает значения: |
online - Инстанс может принимать/отправлять сообщения, сокет открыт | ||
offline - Инстанс не может принимать/отправлять сообщения, сокет закрыт |
Поля объекта instanceData
Параметр | Тип | Описание |
---|---|---|
idInstance | integer | Идентификатор инстанса. Размер integer равен int64. Значения лежат в диапазоне от 1 до 10 разрядов |
wid | string | Идентификатор аккаунта в формате WhatsApp |
typeInstance | string | Тип мессенджера для инстанса |
Пример тела уведомления#
{
"typeWebhook":"statusInstanceChanged",
"instanceData": {
"idInstance": 1,
"wid": "11001234567@c.us",
"typeInstance":"whatsapp"
},
"timestamp": 1586700690,
"statusInstance": "online"
}