Статус инстанса#
Входящее уведомление данного типа содержит данные о состоянии авторизации инстанса
Настройка инстанса
Чтобы получать входящие уведомления о сообщениях с геолокацией, необходимо включить настройки одним из представленных вариантов:
-
Через личный кабинет включить настройку
Получать уведомления об изменении состояния авторизации аккаунта
-
Через метод SetSettings включить настройку
stateWebhook
Уведомление#
Формат уведомления#
Параметр | Тип | Описание |
---|---|---|
typeWebhook | string | Тип входящего уведомления. Для уведомлений данного типа поле принимает значение stateInstanceChanged |
instanceData | object | Данные об инстансе |
timestamp | integer | Время наступления события в UNIX-формате |
stateInstance | string | Состояние инстанса. Принимает значения: |
notAuthorized - Инстанс не авторизован. Для авторизации инстанса обратитесь к разделу Перед началом работы | ||
authorized - Инстанс авторизован | ||
blocked - Инстанс забанен | ||
sleepMode - Статус устарел. Инстанс ушел в спящий режим. Состояние возможно, когда выключен телефон. После включения телефона может потребоваться до 5 минут для перевода состояния инстанса в значение authorized . | ||
starting - Инстанс в процессе запуска (сервисный режим). Происходит перезагрузка инстанса, сервера или инстанс в режиме обслуживания. Может потребоваться до 5 минут для перевода состояния инстанса в значение authorized . | ||
yellowCard - На инстансе частично или полностью приостановлена отправка сообщений из-за спамерской активности. Сообщения отправленные после получения статуса хранятся в очереди к отправке 24 часа. Для продолжения работы инстанса требуется сделать перезагрузку инстанса |
Поля объекта instanceData
Параметр | Тип | Описание |
---|---|---|
idInstance | integer | Идентификатор инстанса. Размер integer равен int64. Значения лежат в диапазоне от 1 до 10 разрядов |
wid | string | Идентификатор аккаунта в формате WhatsApp |
typeInstance | string | Тип мессенджера для инстанса |
Пример тела уведомления#
{
"typeWebhook":"stateInstanceChanged",
"instanceData": {
"idInstance": 1,
"wid": "",
"typeInstance":"whatsapp"
},
"timestamp": 1586700690,
"stateInstance": "notAuthorized"
}