> ## Documentation Index
> Fetch the complete documentation index at: https://gowa-docs.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# События WebSocket

> Подключите панель инструментов к веб-сокету GOWA, управляйте событиями подключения и обновите состояние устройства после переподключения или завершения входа.

GOWA отправляет события сопряжения и устройств через `/ws`. Каждый кадр содержит JSON-объект с машиночитаемым полем `code`, понятным человеку полем `message` и полем `result`, структура которого зависит от события.

## Подключиться

Используйте `/ws` под вашим `APP_BASE_PATH`, например, `wss://gowa.example.com/gowa/ws`. Выберите устройство с `?device_id=<id>`. Когда основная аутентификация включена, клиенты браузера передают значение base64 в формате `user:password` как `authorization`. Клиенты, которые могут установить заголовок `Authorization` может использовать основную аутентификацию через этот заголовок. Используйте `wss://` и redact строку запроса в логах прокси. Добавьте источник приборной панели в [доверенное имя браузера GOWA](https://gowa-docs.mintlify.site/ru/authentication.md#cors), если вы принимаете его отдельно.

Каждый подключенный сокет получает каждую рассылку, даже если подключение указывает устройство. Используйте `result.device_id`, чтобы определить затронутый слот при наличии. Предоставить доступ к WebSocket только для звонящих, доверенных всем устройствам.

## Событие полезных нагрузок

| `code` | Когда он прибывает | `result` |
| - | - | - |
| `LIST_DEVICES` | Клиент посылает `FETCH_DEVICES`. | Список устройств с записями `name`, `device` и `jid`. |
| `LOGIN_SUCCESS` | WhatsApp парит устройство. | `null`. Обновите статус устройства через REST. |
| `PASSKEY_REQUEST` | WhatsApp запрашивает подтверждение ключа. | `device_id`, `challenge` (опции WebAuthn). |
| `PASSKEY_CONFIRMATION` | WhatsApp сообщает о результатах передачи пароля. | `device_id`, `code`, `skip_handoff_ux`. Когда `skip_handoff_ux` верно, активный QR-поток отправляет подтверждение автоматически. В противном случае сравните код с телефоном и позвоните в `POST /app/passkey/confirm`. |
| `PASSKEY_ERROR` | Ошибка при соединении с паролем. | `device_id`, `continuation`. Читайте текст ошибки из `message`. |
| `DEVICE_LOGGED_OUT` | Устройство выходит и сохраняет свой слот. | `device_id` и `reason` для удаленного выхода из системы или `devices` для выхода из API. Форма списка зависит от конечной точки выхода. |
| `DEVICE_REMOVED` | Слот устройства удален. | `device_id`, `devices` (остальные слоты). |
| `DEVICE_STREAM_REPLACED` | Другой клиент подключается к той же сессии WhatsApp. | `device_id`. |
| `DEVICE_TEMPORARY_BAN` | WhatsApp сообщает о временном бане. | `device_id`, `code`, `reason`, `expires_in_seconds`, и `expires_at` после истечения срока действия. |
| `DEVICE_REACHOUT_TIMELOCK` | Отчеты WhatsApp или отмена ограничений на начало новых чатов. | `device_id`, `is_active`, и необязательные `enforcement_type` и `ends_at`. |
| `DEVICE_WEBHOOK_UPDATED` | Webhook на устройстве меняется URL-адрес. | `device_id`, `webhook_url`. |
| `DEVICE_WEBHOOK_CONFIG_UPDATED` | Параметры вебхука на устройстве изменены. | `device_id`. |

## Обновить состояние устройства

Для запроса списка поверх сокета, отправьте `{"code":"FETCH_DEVICES"}` в виде текстового фрейма. GOWA транслирует результирующее событие `LIST_DEVICES` во все сокеты. Чтобы получить текущее состояние после переподключения или ремонта, позвоните `GET /devices` или `GET /devices/{device_id}/status`. События WebSocket являются переходными.

```javascript theme={null}
const url = new URL("wss://gowa.example.com/ws");
url.searchParams.set("device_id", "my-device");
url.searchParams.set("authorization", btoa("admin:changeme"));

const socket = new WebSocket(url);
socket.addEventListener("open", () => {
  socket.send(JSON.stringify({ code: "FETCH_DEVICES" }));
});
socket.addEventListener("message", ({ data }) => {
  const { code, result } = JSON.parse(data);
  if (code === "LIST_DEVICES") {
    console.log("Device list", result);
  }
  if (code === "DEVICE_LOGGED_OUT" && result?.device_id === "my-device") {
    console.log("Device logged out", result.device_id);
  }
});
```

Смотрите [сопряжение с паролем](https://gowa-docs.mintlify.site/ru/authentication.md#%D0%BF%D0%B0%D1%80%D0%BE%D0%BB%D1%8C) для REST вызовов, выполняющих парольный запрос. Используйте [webhooks](https://gowa-docs.mintlify.site/ru/concepts/webhooks.md) для обработки сообщений и квитанций WhatsApp.


## Related topics

- [Проверка подлинности](https://gowa-docs.mintlify.site/ru/authentication.md)
- [Мульти-устройство и выбор устройства](https://gowa-docs.mintlify.site/ru/concepts/multidevice.md)
- [Вебхуки](https://gowa-docs.mintlify.site/ru/concepts/webhooks.md)
- [Справочник по API](https://gowa-docs.mintlify.site/ru/api-reference/introduction.md)
- [Ссылка на конфигурацию](https://gowa-docs.mintlify.site/ru/configuration.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.