Команда echo

Команда echo при первом подключении создает новую модель для заданного пользователя с заданным алгоритмом. При повторном запуске с теми же параметрами она подключается к уже запущенной модели.

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

Поля запроса команды start

ПолеТип поляНазначение
CommandJSONКорневой элемент, содержащий собственно текст запроса
CommandTypestringТип команды. В случае команды echo, нужно указать значение echo
CommandIdstringИдентификатор команды, для удобства отладки. Используется на усмотрение разработчика программы-агента. Можно указать любой текст, например UUID
ArgsJSONАргументы команды. У команды echo аргументов нет, поэтому этот параметр можно не передавать

Пример запроса команды echo

Пример запроса, содержащий команду echo:

{
  "Command": {
    "CommandType": "echo",
  }
}

Схема ответа

Поля ответа команды echo

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

Пример ответа команды echo

Пример ответа, возвращающегося в результате выполнения команды echo:

{
  "Response": {
    "Command": {
      "CommandType": "echo",
      "CommandId": ""
    },
    "Status": 0,
    "ErrorCode": "NPE001"
  }
}