Документация Websocket

Websocket - это полно-дуплексный протокол связи. Страница в Википедии об этом протоколе.

В tada.team websockets используются для уведомления клиентов о событиях и голосовых вызовах.

Подключение к websocket

Ссылка чтобы присоединиться к websocket имеет форму wss://web.tada.team/messaging/{team_id} где team_id это JID команды для которой создать websocket. Это значит что для каждой команды нужен отдельное websocket соединение чтобы получать события из нескольких команд.

web.tada.team может быть заменено на другой домен.

Для соединения с websocket необходима авторизация. Для авторизации нужно включить HTTP header token с токеном бота в запросе на соединение. Смотрите Как создать бота o том как создать токен бота.

JSON объекты событий

Все события с сервера или на сервер должны быть завернуты в объект события.

Объект события имеет следующие поля:

  • event (string) - Название события. Например, "client.activity".

  • confirm_id (string) - В основном используется для отладки. Должно быть случайная строка.

  • params (object) - Сам объект события.

Пример:

{
     "confirm_id": "75a406625c58",
     "event": "client.activity",
     "params": {
             "afk": true
     }
}

Это пример client.activity события отправленного клиентом чтобы поставить статус AFK.

Список событий

События клиента. Эти события клиент может отправить на сервер.

События сервера. Эти события приходят с сервера.