Skip to content

Прослушивание событий

📡 Прослушивание событий по веб сокету#

Ручка#

ws /ws/v1/listen_events

Полный адрес в сети#

Среда URL
🧪 Dev ws://web-socket-gateway.devterra.ru/ws/v1/listen_events
🚀 Prod ws://web-socket-gateway.terraprod.ru/ws/v1/listen_events
Ping Pong

Для поддержания постоянного соединения без разрывов, необходимо с периодичностью 10-30 секунд отправлять текстовое сообщение "ping"

В ответ, сервер отправит "pong"

Входные данные для прослушивания#

Поле Тип Описание Обязательное Пример
apiKey string Ключ авторизации ✅ 47f44e56-2e4f-407e-8b07-115ea8783be7

Пример JSON запроса#

{
  "apiKey": "86116c76-eafe-4f15-876b-ab1f3660da28"
}

Выходные данные, которые будут в ответе#

Поле Тип Описание Обязательное Пример
userID string uuid пользователя ❌ 47f44e56-2e4f-407e-8b07-115ea8783be7
message string Тип сообщения (см. в константах) ✅ UPDATE_REGISTRATION_ON_EVENT
registrationID int32 ID записи ❌ 1
userInfo json Актуальная информация о пользователе ❌ get_user_info

Пример JSON ответов#

{
  "userID": "86116c76-eafe-4f15-876b-ab1f3660da28",
  "message": "UPDATE_REGISTRATION_ON_EVENT",
  "registrationID": 1,
  "userInfo": null
}

{
  "userID": "86116c76-eafe-4f15-876b-ab1f3660da28",
  "message": "UPDATE_PROFILE",
  "registrationID": null,
  "userInfo": {
    "см. ручку": "get_user_info"
  }
}