Перейти к основному содержимому

Отмена существующей подписки

Приватный ресурс

Запрос нельзя выполнить анонимно. Обязательный параметр token должен содержать актуальный Access Токен.

Запрос отменяет созданную ранее подписку на информационный канал. Отменяемая подписка определяется значением параметра guid. Отмена подписки выполняется в том же WebSocket-соединении, где она была создана.

Запрос​

Чтобы отменить ранее созданную подписку, отправьте в WebSocket-соединение, в рамках которого действует подписка, сообщение с телом запроса, содержащим её идентификатор.

{
  "opcode": "unsubscribe",
  "guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
  "token": "eyJhbGciOiJ..."
}

Ответы​

В зависимости от результатов обработки полученного запроса сервер вернёт в то же WebSocket-соединение сообщение с соответствующим кодом ответа:

  • Если запрос обработан успешно, сервер передаст в ответ одно сообщение с кодом 200, подтверждающее отмену указанной подписки.
  • Если обработка запроса завершилась неудачей, сервер передаст в ответ одно сообщение с кодом ошибки, соответствующим причине отказа, после чего закроет WebSocket-соединение.

Сообщение об успешной обработке запроса. Ответ с этим кодом возвращается в случае успешной обработки запроса сервером независимо от того, обнаружена ли подписка с указанным guid в рамках WebSocket-соединения.

{
  "message": "Handled successfully",
  "httpCode": 200,
  "requestGuid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}