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

Получить QR-код через websocket#

Наравне с получением QR-кода методом QR существует возможность получить QR-код через websocket-соединение. Таймаут ожидания сканирования QR-кода составляет 100 сек. За это время QR-код должен быть отсканирован. Для получения QR-кода аккаунт должен быть в неавторизованном состоянии. Если аккаунт авторизован, то предварительно требуется разлогинить аккаунт методом Logout.

После успешного сканирования QR-кода и авторизации аккаунта формируется входящее уведомление с видом Статус аккаунта.

Для получения QR-кода требуется установить websocket-соединение по адресу:

wss://api.green-api.com/waInstance{{idInstance}}/scanqrcode/{{apiTokenInstance}

Ответ#

Поля ответа#

Поле Тип Описание
type string Тип сообщения, возможные значения qrCode, error, accountData, alreadyLogged, timeoutExpired
message string Содержание сообщения. Принимает различные значения в зависимости от значения поля type

Получено изображение QR-кода#

Поле Тип Описание
type string qrCode - получено изображение QR-кода
message string Изображение QR-кода в кодировке base64. Для вывода в браузере нужно добавить строку data:image/png;base64, {message}

Возникла ошибка#

Поле Тип Описание
type string error - возникла ошибка
message string Описание ошибки

Аккаунт уже авторизован#

Поле Тип Описание
type string alreadyLogged - аккаунт уже авторизован. Для получения QR-кода требуется предварительно разлогинить аккаунт методом Logout
message string Принимает значение instance account already authorized

Истек таймаут ожидания сканирования QR-кода#

Поле Тип Описание
type string timeoutExpired - истекло время, в течение которого QR-код должен быть отсканирован. Таймаут ожидания сканирования QR-кода составляет 100 сек.
message string Принимает значение timeoutExpired

Получены данные авторизованного аккаунта#

Поле Тип Описание
type string accountData - получены данные аккаунта после успешной авторизации
wid string Идентификатор аккаунта в формате WhatsApp
pushname string Имя аккаунта в WhatsApp
proxy string IP-адрес прокси, который назначен аккаунту
webhookUrl string URL для получения входящих уведомлений