API & CLI (command line interface) HiTech OWC системы видеоконференции:


API & CLI (command line interface) HiTech OWC системы видеоконференции
Для того, чтобы воспользоваться этим интерфейсом надо установить соединение по SSH с терминалом с определенными учетными данными. В качестве логина использовать "admin", пароль задается в веб интерфейсе в разделе "Администрирование".

После установления соединения и ввода пароля открывается командный интерфейс, в котором доступны команды, описанные ниже.

Список команд

ANSWER - принять входящий вызов

Параметр Значение
VIDEO Принять входящий вызов, если Автоприем входящих вызовов выключен

AUDIOCODEC - разрешить или запретить использование аудиокодека

Параметр Значение
<CODEC> ON Разрешить использовать аудиокодек <CODEC>
<CODEC> OFF Запретить использовать аудиокодек <CODEC>
<CODEC> GET Получить текущее состояние кодека <CODEC>
GET Получить текущее состояние всех аудиокодеков
Допустимые кодеки: G719, AAC, OPUS, G722-1, G722-1-24, G722-1- 32, G722-1C, G722-1C-24, G722-1C-32, G722-1C-48, G722, G729, G728, G726, G726-16, G726-24, G726-32, G726-40, G723, G711

AUDIOMUTE - управление микрофоном

Параметр Значение
ON Отключить микрофон
OFF Включить микрофон
GET Получить текущее состояние микрофона
REGISTER Получать уведомления на изменение состояния микрофона. Если пользователь будет включать/выключать микрофон, то в консоль будут поступать уведомления
UNREGISTER Отключить уведомления на изменение состояния микрофона

AUTOANSWER - установить режим автоответа

Параметр Значение
YES Разрешить автоответ на входящие вызовы
NO Запретить автоответ на входящие вызовы.
DND Запрет входящих, все вызовы будут отбиваться
GET Получить состояние автоответа

CALLINFO - получить информацию о текущем вызове

Параметр Значение
CallID Номер
Команда выводит техническую информацию об одном или нескольких вызовах.
Параметр "CallID" нужен для идентификации вызова и используется в других командах. Пример работы команды:
(tcg cli) callinfo Active calls:
CallID:"8"
Direction:Outgoing
Contact URI:"sip:admin@demoi.owc.ru" User agent:"VCon Server 5.0.0.1586" Duration:230 sec
Bitrate:"1008"
Audio in: Compression:"G.722.1C (32 kbit/s)", Bitrate:"32", Packets:"11304", Lost packets:"0", Loss rate:"0"%, Jitter:"30"
Audio out: Compression:"G.722.1C (48 kbit/s)", Bitrate:"48", Packets:"11301", Lost packets:"0", Loss rate:"0"%, Jitter:"10"
Video in: Codec:"H264", Bitrate:"960", Resolution:"1280x720", Frame rate:"27", Packets:"35495", Lost packets:"0", Lossrate:"0%", Jitter:"11%"
Video out: Codec:"H264", Bitrate:"960", Resolution:"1280x720", Frame rate:"30", Packets:"39959", Lost packets:"0", Lossrate:"0%", Jitter:"2%

CALLHISTORY- история вызовов

Параметр Значение
N Получить информацию о последних N вызовах. По умолчанию N= 10
Пример:
(tcg cli) callhistory
List of records in call history:
#0: Caller id:'VCon MCU', uri:h323:10.110.0.232:1720, dir:outgoing, status:completed, started:2023/02/02 10:41:49, duration:0:00:09
#1: Caller id:'VCon MCU', uri:h323:10.110.0.226:1720, dir:outgoing, status:completed, started:2023/02/01 18:22:30, duration:0:01:03

CAMERA - управление PTZ камерой

Параметр Значение
LEFT, RIGTH, UP, DOWN Повернуть камеру соответственно влево, вправо, вверх, вниз
ZOOM+ / ZOOM- Приблизить или отдалить изображение
STOP Остановить перемещение камеры

CAMERAMUTE - управление изображением с камеры

Параметр Значение
ON Отключить видеопоток от камеры
OFF Включить видеопоток от камеры
GET Получить текущее состояние видеопотока от камеры
REGISTER Подписаться на получение уведомлений на отключение/включение камеры пользователем
UNREGISTER Отписаться от уведомлений

CONTENT - управление контентом

Параметр Значение
PREVIEW Включить предварительный просмотр контента, не отправляя его в конференцию
SHARE Транслировать контент в конференцию
STOP Остановить трансляцию контента
GET Запросить текущий статус передачи контента
REGISTER Регистрация на событие изменения состояния второго потока

CORETEMP - запрос температуры процессора

Пример:
(tcg cli) coretemp
CPU temperature: +41.0°

DIAL - вызов абонента

Параметр Значение
URI Осуществить исходящий вызов по заданному URI
Пример уведомления при входящем вызове:
Incoming call [3], ringing: Name:"Ioan"
Contact URI:sip:ioan@team.owc.ru:5060
User agent:"VCon Server 10.0.0.1519"
Incoming call [3] confirmed: Name:"Ioan"
Contact URI:sip:ioan@team.owc.ru:5060
User agent:"VCon Server 10.0.0.1519"
Пример уведомления при исходящем вызове:
(tcg cli) dial sip:ioan@team.owc.ru Dial passed succsessfully
Name:"IOAN"
Contact URI:"sip:IOAN@TEAM.OWC.RU:5060" CallID:"4"
Bitrate:"1904"
User agent:"VCon Server 10.0.0.1519" (tcg cli)
Outgoing call [4] confirmed: Name:"IVAN"
Contact URI:"sip:IOAN@TEAM.OWC.RU:5060"
User agent:"VCon Server 10.0.0.1519"

DTMF - отправить DTMF код в вызов

Отправить DTMF код CODE в вызов с номером [CallID]. Код состоит из цифр и обычно заканчивается символом "#"
Параметр Значение
[CallID] Идентификатор вызова. Если вызов один, то параметр можно опустить
CODE Код, состоящих из DTMF символов, которые должны быть отправлены в линию. Специальный символ "Р" добавляет паузу в 100мсек.
Пример использования:
(tcg cli) dtmf 1p2p3p#
DTMF code passed successfully
Пример уведомления об завершении вызова

HANGUP - завершить вызов

Параметр Значение
VIDEO [CallID] Завершить вызов с ID "CallID". Значение "CallID" выводится при установлении соединения
ALL Завершить все текущие вызовы
Пример уведомления об завершении вызова:
Hangup call [3]: Name:"Ioan"
Contact URI:"sip:ioan@team.owc.ru:5060"

HOSTNAME - получить или установить Имя системы

Параметр Значение
SET <NAME> Установить Имя системы
GET Запросить Имя системы

IP - получить IP адрес устройства и таблицу маршрутов

Параметр Значение
ADDRESS Запросить IP адрес устройства
ROUTE Запросить таблицу маршрутизации
Пример:
(tcg cli) ip address
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00 inet 127.0.0.1/8 scope host lo
valid_lft forever preferred_lft forever inet6 ::1/128 scope host
valid_lft forever preferred_lft forever
2: enp3s0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000
link/ether fc:34:97:b5:27:9d brd ff:ff:ff:ff:ff:ff
inet 10.110.15.107/20 brd 10.110.15.255 scope global noprefixroute dynamic enp3s0
valid_lft 17001sec preferred_lft 17001sec
inet6 fe80::a2ae:aacd:71a5:a/64 scope link noprefixroute valid_lft forever preferred_lft forever
(tcg cli) ip route
default via 10.110.0.1 dev enp3s0 proto dhcp metric 100
10.110.0.0/20 dev enp3s0 proto kernel scope link src 10.110.15.107 metric 100

LAYOUT- изменить раскладку конференции для многоточечного вызова

Параметр Значение
EQUAL Включить равноправную раскладку
TOP Включить раскладку с расположением участников сверху
LEFT Включить раскладку с расположением участников слева
BOTTOM Включить раскладку с расположением участников снизу
RIGHT Включить раскладку с расположением участников справа
AUTO Включить автоматическую раскладку
GET Получить текущую раскладку

LISTDEVICE - получить список доступных аудио/видео устройств, подключенных к терминалу

Параметр Значение
AUDIO Получить список всех аудио устройств, подключенных к терминалу
AUDIO CAPTURE Получить список всех аудио устройств захвата, подключенных к терминалу
AUDIO RENDER Получить список всех аудио устройств воспроизведения, подключенных к терминалу
VIDEO Получить список всех видео устройств, подключенных к терминалу
VIDEO CAPTURE Получить список всех видео устройств захвата изображения, подключенных к терминалу
VIDEO RENDER Получить список всех устройств вывода изображения (дисплеев), подключенных к терминалу
SERIAL Получить список подключенных последовательных портов. Может быть использована для идентификации подключенных внешних адаптеров RS323-USB
Пример вызова:
(tcg cli) listdevice
Available audio capture devices:
id="1", "Phoenix Quattro3", active:False, default:False, level:100%, boost:0, aec:0, agc:False, noise suppressor:False
id="2", "Line in", active:False, default:False, level:100%, boost:0, aec:0, agc:False, noise suppressor:False
id="3", "Alctron XU-2MKII [USB Audio]", active:True, default:False, level:100%, boost:0, aec:0, agc:False, noise suppressor:False
id="4", "Logitech Webcam C930e [USB Audio]", active:False, default:False, level:100%, boost:0, aec:0, agc:False, noise suppressor:False
Available audio render devices:
id="1": "Phoenix Quattro3", active:True, default:False, level:33% id="2": "Display port", active:False, default:False, level:74% id="3": "HDMI", active:False, default:False, level:50%
id="4": "Line out", active:False, default:False, level:50%
id="5": "Alctron XU-2MKII [USB Audio]", active:False, default:False, level:50% Available video capture devices:
id="1": "Clevermic 1005U/USB3.0 FULL HD PTZ", video:1920x1080@30.0
id="2": "Logitech Webcam C930e/Logitech Webcam C930e", video:1920x1080@30.02 Available video render devices:
id="1": "PHL 243V7", port: HDMI", active:True (tcg cli) listdevice serial
List of available serial ports:
ttyUSB0

MENU - отобразить меню на экране терминала

Параметр Значение
Без параметра открывает на экране терминала основное меню
ABOOK Открывает меню адресной книги
HISTORY Открывает меню истории вызовов
INFO Открывает информацию о вызове

MULTIPOINT - разрешить или запретить многоточечные вызовы

Параметр Значение
ON Разрешить многоточечные вызовы
OFF Запретить многоточечные вызовы
GET Запросить текущее состояние многоточечных вызовов

PROTOCOL- запросить / изменить параметры протоколов

Параметр Значение
SIP <ON/OFF/GET> Включить/выключить протокол SIP, запросить состояние
H323 <ON/OFF/GET> Включить/выключить протокол H323, запросить состояние
SIP SRTP <ON/OFF/MANDATORY/GET> Включить/выключить протокол SRTP, запросить состояние. MANDATORY означает требование обязательно использовать протокол удаленной стороной при подключении
H323 H235 <ON/OFF/MANDATORY/GET> Включить/выключить протокол H235, запросить состояние. MANDATORY означает требование обязательно использовать протокол удаленной стороной при подключении

REBOOT -выполнить перезагрузку устройства RCKEY - послать код кнопки пульта ДУ

Параметр Значение
KEY Код кнопки пульта. Допустимые значения: 0..9, *, #, HOME, BACK, MENU, OK, LEFT, RIGHT, UP, DOWN, DIAL, BACKSPACE, HANGUP, PC, FARNEAR, LAYOUT, ZOOM+, ZOOM-, VOL+, VOL-, POWER
Пример:
(tcg cli) rckey home RCKEY passed successfully

SELFVIEW - установить режим отображения собственного локального видео

Параметр Значение
ON Отображать локальное видео
OFF Скрывать локальное видео
TOGGLE Переключить локальное видео
GET Запросить состояние локального видео

SETDEVICE - выбрать устройство захвата / вывода звука/видео

Параметр Значение
AUDIO CAPTURE <DeviceId> Выбрать устройство "DeviceId" в качестве источника звука. "DeviceId" можно получить, вызвав команду LISTDEVICE
AUDIO RENDER <DeviceId> Выбрать устройство "DeviceId" для вывода звука.
VIDEO CAMERA <DeviceId>) Выбрать устройство захвата для основного потока (в качестве камеры)
VIDEO PRESENTATION <DeviceId> Выбрать устройство захвата для дополнительного потока (в качестве контента)
VIDEO PRIMARY <DeviceId> Выбрать дисплей для отображения видео основного потока
VIDEO SECONDARY <DeviceId> Выбрать дисплей для отображения видео дополнительного потока
VIDEODUAL ALL Включить второй дисплей
VIDEODUAL OFF Отключить второй дисплей
VIDEODUAL MIRROR Отображать на втором дисплее то же самое, что и на первом
VIDEODUAL PRESENTATION Выводить на второй монитор дополнительный видеопоток (контент)
SERIAL Выбрать устройство для работы CLI. Может быть либо аппаратный порт RS232, либо адаптер USB-RS232
Пример:
(tcg cli) setdevice serial ttyUSB0 Command passed succesfully

SHUTDOWN - выключить устройство SPEAKERMUTE- управление выводом звука

Параметр Значение
ON Отключить вывод звука на динамик устройства
OFF Включить вывод звука на динамик устройства
GET Получить текущее состояние динамика устройства
OFF Включить вывод звука на динамик устройства
GET Получить текущее состояние динамика устройства
REGISTER Зарегистрироваться на получение уведомлений о состоянии устройства
UNREGISTER Отключить получение уведомлений о состоянии устройства

VIDEOCODEC - разрешить или запретить использование видеокодека

Параметр Значение
<CODEC> ON Разрешить использование видеокодека <CODEC>
<CODEC> OFF Запретить использование видеокодека <CODEC>
(CODEC) GET Получить текущее состояние видеокодека <CODEC>
GET Получить текущее состояние всех видеокодеков
Доступные видеокодеки H261, H263, H264, H264HP, H265

VIDEOMIXER - задать режим работы видео микшера для многоточечного соединения

Параметр Значение
VIDEOLESSON Режим видеоурока, когда участники видят лектора, а лектор видит всех. Однако, все слышат друг друга.
ALL Включить режим, когда все участники располагаются на одном экране
ACTIVESPEAKER Включает режим, когда приоритетное окно показывает активного говорящего

VOLUME - управление громкостью звука

Параметр Значение
UP Увеличить громкость на одну ступень
DOWN Уменьшить громкость на одну ступень
GET Получить текущее состояние громкости
REGISTER Зарегистрироваться на получение уведомлений об изменении громкости
UNREGISTER Отключить получение уведомлений об изменении громкости

WHOAMI - получить общую информацию об устройстве

Пример вызова:
(tcg cli) whoami
Information about the system:
Display Name:"HiTech OWC Зал" Serial Number:"12345678" License Type:"permanent"
Software version:"1.0.58.4 Nov 10 2021" Connections limit:"4"
IP address:"10.110.12.68" MAC:"04:D9:F5:CA:EF:63"
SIP:"" HiTech OWC Зал " <sip:10.110.12.68>" H323:"10.110.12.68"
H323 Gatekeeper:"" SIP Server:""
H323 Name:""
H323 Extension:"" Display information: Name:"PHL 243V7"
Connected:"True" Active:"True"
Mode:"1920x1080@60.0 [30.4]"
Вы всегда найдете у нас нужное оборудование видеоконференций по лучшей цене!
Мы всегда предложим Вам разумное, хорошо работающее техническое решение!
Вы всегда получите грамотную техническую консультацию бесплатно!
Вы запутались с сетевыми настройками
Вы хотите взять оборудование видеоконференции в аренду
Вы хотите пригласить нашего специалиста в свой офис
Вы хотите пригласить своих коллег в других городах или странах в студию
Мы поможем решить все эти вопросы.
+7 (499) 964-72-39
или по электронной почте: owc@owc.ru