Wialon для разработчиков Руководство пользователя Документация API unit exec_cmd

exec_cmd

Для отправки команды на объект используйте метод unit/exec_cmd.

Конечная точка

Copied!

svc=unit/exec_cmd&params={
  "itemId": <long>,
  "commandName": "<text>",
  "linkType": "<text>",
  "param": "<text>",
  "timeout": <uint>,
  "flags": <uint>
}

Параметры

Обязательные параметры отмечены звездочкой (*).

Параметр	Описание
`itemId`*	ID объекта.
`commandName`*	Имя команды.
`linkType`*	Тип связи (см. unit/update_command_definition). Если тип связи указан в свойствах команды, команда отправляется по этому типу связи, а значение этого параметра игнорируется. Если тип связи не указан ни в запросе, ни в свойствах команды, он выбирается автоматически из тех, по которым команда доступна в данный момент.
`param`*	Параметры команды. Если у команды нет параметров, укажите пустую строку. Если параметры указаны в свойствах команды, используются они, а значение этого параметра игнорируется.
`timeout`*	Время нахождения команды в очереди команд, в секундах.
`flags`	Флаги выбора номера телефона для выполнения команды: 0: использовать любой (сначала основной, затем дополнительный); 0x1: использовать основной; 0x2: использовать дополнительный; 0x10: передать `param` в формате JSON. Если значение не равно 0, оно заменяет младший байт (0x01–0xFF) флагов, указанных в свойствах команды, а остальные флаги берутся из свойств команды. Если параметр не указан или равен 0, используются флаги из свойств команды.

Ответ

Если запрос выполнен успешно, возвращается пустой объект:

Copied!

{}

Если запрос не выполнен, возвращается код ошибки.

Коды ошибок

Код ошибки	Описание
4	Неверные входные параметры, например отсутствует один из обязательных параметров.
5	Не удалось выполнить команду. Эта ошибка возвращается в следующих случаях: у объекта нет команды с указанным именем; у пользователя нет прав доступа, необходимых для выполнения этой команды (заданы в свойствах команды); команда в данный момент недоступна по используемому типу связи, например такого типа связи не существует, у объекта нет действительного номера телефона для отправки SMS или тип устройства не поддерживает эту команду по этому типу связи; команду не удалось поставить в очередь, например потому что объект не подключен по TCP.
7	Объект не существует, или у пользователя нет права доступа Отправка команд на него.

Если вы заметили ошибку в тексте, пожалуйста, выделите её и нажмите Ctrl+Enter.