Отмена существующей подписки
Приватный ресурс
Запрос нельзя выполнить анонимно. Обязательный параметр token
должен содержать актуальный Access токен.
Запрос отменяет созданную ранее подписку на информационный канал. Отменяемая подписка определяется значением параметра guid
. Отмена подписки выполняется в том же WebSocket-соединении, где она была создана.
Запрос
Чтобы отменить ранее созданную подписку, отправьте в WebSocket-соединение, в рамках которого действует подписка, сообщение с телом запроса, содержащим её идентификатор.
- Тело запроса
- Схема
{
"opcode": "unsubscribe",
"guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
"token": "eyJhbGciOiJ..."
}
Параметры тела запроса
OrderBookGetAndSubscribe
— Подписка на биржевой стаканBarsGetAndSubscribe
— Подписка на историю цен (свечи)QuotesSubscribe
— Подписка на информацию о котировкахInstrumentsGetAndSubscribeV2
— Подписка на изменение информации о финансовых инструментах на выбранной биржеAllTradesGetAndSubscribe
— Подписка на все сделкиPositionsGetAndSubscribeV2
— Подписка на информацию о текущих позициях по торговым инструментам и деньгамSummariesGetAndSubscribeV2
— Подписка на сводную информацию по портфелюRisksGetAndSubscribe
— Подписка на сводную информацию по портфельным рискамSpectraRisksGetAndSubscribe
— Подписка на информацию по рискам срочного рынка (FORTS)TradesGetAndSubscribeV2
— Подписка на информацию о сделкахOrdersGetAndSubscribeV2
— Подписка на информацию о текущих заявках на рынке для выбранных биржи и финансового инструментаStopOrdersGetAndSubscribeV2
— Подписка на информацию о текущих заявках на рынке для выбранных биржи и финансового инструментаunsubscribe
— Отмена существующей подписки
Код выполняемой операции:
Уникальный идентификатор запроса. Все ответные сообщения будут иметь такое же значение поля guid
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Access Токен для авторизации запроса
Пример: eyJhbGciOiJ...
Ответы
В зависимости от результатов обработки полученного запроса сервер вернёт в то же WebSocket-соединение сообщение с соответствующим кодом ответа:
- Если запрос обработан успешно, сервер передаст в ответ одно сообщение с кодом
200
, подтверждающее отмену указанной подписки. - Если обработка запроса завершилась неудачей, сервер передаст в ответ одно сообщение с кодом ошибки, соответствующим причине отказа, после чего закроет WebSocket-соединение.
Сообщения
- 200
- 401
Сообщение об успешной обработке запроса. Ответ с этим кодом возвращается в случае успешной обработки запроса сервером независимо от того, обнаружена ли подписка с указанным guid
в рамках WebSocket-соединения.
- Тело ответа
- Схема
{
"message": "Handled successfully",
"httpCode": 200,
"requestGuid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}
Параметры тела ответа
Текстовое представление возвращаемого сообщения
Пример: Handled successfully
Код возвращаемого сообщения
Пример: 200
Уникальный идентификатор запроса. Значением выступает параметр guid
, указанный в теле запроса
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Не удалось авторизовать запрос — Access Токен не указан в теле запроса, срок его действия истёк или он относится к другому контуру системы
- Тело ответа
- Схема
{
"requestGuid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
"httpCode": 401,
"message": "Invalid JWT token!"
}
Параметры тела ответа
Уникальный идентификатор запроса. Значением выступает параметр guid
, указанный в теле запроса
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Код возвращаемого сообщения
Пример: 401
Текстовое представление возвращаемого сообщения
Пример: Invalid JWT token!