Команды Websockets API

Список доступных команд включает:

Название командыНазначение команды
startЗапуск новой модели или переподключение к существующей
subscribeПодписка на события заданного типа
unsubscribeОтписка от событий заданного типа
echoОтправка пустого сообщения (как правило, для сохранения связи с сервером)

Базовая схема запросов и ответов для всех команд

Все команды соответствуют определенной общей схеме, которая приведена ниже.

Схема запроса

ПолеТип поляНазначение
CommandJSONКорневой элемент, содержащий собственно текст запроса
CommandTypestringТип команды (start, stop, subscribe, unsubscribe, echo)
CommandIdstringИдентификатор команды, для удобства отладки. Используется на усмотрение разработчика программы-агента. Можно указать любой текст, например UUID
ArgsJSONАргументы команды
AccessTokenstringТокен доступа, который необходимо получить с помощью API авторизации

Схема ответа

ПолеТип поляНазначение
ResponseJSONКорневой элемент для ответа
CommandJSONПолное повторение команды, пришедшей от клиента, со всеми дочерними полями
StatusintegerСтатус выполнения команды (0 — успешное выполнение, 1 — ошибка)
ErrorCodestringСимволический код ошибки, в соответствии со справочником кодов ошибок Websockets API
BodyJSONДополнительная информация о результатах выполнения команды