You can connect to the terminal via SSH protocol and control it with text commands in console mode. Login and password for SSH access are the same as for the web interface.
The following command descriptions are valid starting with terminal version 2.9.2
Command description
| mute | keyword |
|---|---|
| mandatory argument, a user must specify its value | |
| <on/off> | mandatory argument that can take only the specified set of values |
| [ |
optional argument, a user can specify it if necessary |
| <“name”> | mandatory string argument; if it contains spaces, pass it in quotes |
| ping | send ICMP ECHO_REQUEST packets to a network host |
| traceroute | print the route packets take to a network host |
| clear | clear the console screen |
| help | show available commands |
| exit !! | exit the command line |
| Own microphone, on/off (bool) | [ |
| Own camera, on/off (bool) | [ |
| Enable/disable microphone command | mute on/off [ |
| Enable/disable camera command | video <on/off> [ |
| Get list of available cameras | camera <list/listndi> response: camera {“cameras”:[{“format”:“YUYV”,“fps”:“30”,“height”:“1080”,“id”:“00-00 Eco Capture Dual HDMI M.2”,“name”:“00-00 Eco Capture Dual HDMI M.2”,“path”:"/dev/video0",“role”:"",“width”:“1920”},{“format”:“YUYV”,“fps”:“30”,“height”:“1080”,“id”:“00-01 Eco Capture Dual HDMI M.2”,“name”:“00-01 Eco Capture Dual HDMI M.2”,“path”:"/dev/video1",“role”:"",“width”:“1920”},{“format”:“MJPG”,“fps”:“30”,“height”:“1080”,“id”:“046d_C922_Pro_Stream_Webcam_3B7BCC8F”,“name”:“C922 Pro Stream Webcam”,“path”:"/dev/video2",“role”:“main&presentation”,“width”:“1920”},{“format”:“MJPG”,“fps”:“30”,“height”:“1080”,“id”:“046d_Logitech_BRIO_20325218”,“name”:“Logitech BRIO”,“path”:"/dev/video4",“role”:"",“width”:“1920”}]} |
| Set camera role command | camera set |
|---|---|
| Change camera position command | camera move <left/right/down/up/zoom+/zoom-/stop> [step] response: camera move left OK (step argument stops the camera after one step without sending stop) |
| Save preset command | camera preset set |
| Go to preset command | camera preset go |
| Get contact list command | addrbook all response: addrbook all [{“id”:8,“name”:“Alex”,“number”:“10.1.0.10”,“status”:“0”,“type”:“auto”},{“id”:6,“name”:“Евгений WS”,“number”:“105”,“status”:“0”,“type”:“H323”},{“id”:2,“name”:“Терминал 114 SIP”,“number”:“101”,“status”:“0”,“type”:“H323”},{“id”:5,“name”:“Терминал 124 H.323”,“number”:“104”,“status”:“0”,“type”:“H323”},{“id”:4,“name”:“Терминал 127 SIP”,“number”:“103”,“status”:“0”,“type”:“H323”},{“id”:3,“name”:“Терминал 130 H.323”,“number”:“10.1.0.130”,“status”:“0”,“type”:“SIP”},{“id”:7,“name”:“Терминал 2.6.1”,“number”:“108”,“status”:“0”,“type”:“H323”},{“id”:1,“name”:“Тимофей WS”,“number”:“100”,“status”:“0”,“type”:“H323”}] |
| Add contact command | addrbook add <“name”> |
| Edit contact command | addrbook edit |
| Remove contact command | addrbook remove |
| Place call command | dial auto |
| End call command | hangup all Response: hangup all OK |
| Disconnect participant command | hangup |
| Accept incoming call command | accept |
| Decline incoming call command | decline |
| Change mosaic command | mosaic <get/auto/single/multi> response: mosaic <auto/single/multi> |
|---|---|
| Show presentation command | presentation <get/start/stop> response: presentation <off|on> |
| Get audio resources command | audio get <sink/source> response: audio {“default”:“alsa_output.pci-0000_00_1f.3.analog-stereo”,“devices”:[{“description”:“Built-in Audio Analog Stereo ALC897 Analog”,“name”:“alsa_output.pci-0000_00_1f.3.analog-stereo”,“plughw”:“0,0”},{“description”:“LG HDR 4K HDMI 0”,“name”:“alsa_output.TERMINAL_HDMI_DEV_3”,“plughw”:“0,3”}]} |
| Set audio device role command | audio set <sink/source> |
| Get volume level command | audio volume <sink/source> get |
| Set volume level command | audio volume <sink/source> set |
| Send remote control events command | button [-t |
| “Do not disturb” mode command | dnd <get/on/off> response: dnd <on/off> |
| Send DTMF codes command | dtmf <1/2/3/4/5/6/7/8/9/0//#> response: dtmf <1/2/3/4/5/6/7/8/9/0//#> OK |
| Get call history command | history [ |
| Shutdown terminal command | shutdown Response: shutdown OK |
| Reboot terminal command | reboot Response: reboot OK |
| Show help command | help Response: help |
| Show logs command | log get <terminal/volumeapp/updater/asterisk/mcu> Response: log |
| Get firmware version command | updates show-last Response: updates |
| Set local update file path command | updates set-path |
| Set update file URL command | updates set-path-url |
| Start update process command | updates start Response: updates OK |
| Get registration status command | SIP/H.323 registration Response: registration {"":[{“enable”:“1”,“ip”:“127.0.0.1:1720 |
| Disable autoanswer command | autoanswer off Response: autoanswer off |
| Set autoanswer delay command | autoanswer on <time(1-30 second)> Response: autoanswer on |
| Get terminal language command | lang get Response: lang ru |
| Set terminal language command | lang set <en/ru> Response: lang <en/ru> |
Terminal event messages
- call-begin visibly: 1 — call start
- call-end visibly: 1 — call end
- call-incoming visibly: 1 — incoming call start
- call-outcoming visibly: 1 — outgoing call start
- call-outcoming-state visibly: 1 — outgoing call status
- mute-set visibly: 1 — mute state change in a call
- video-set — own camera state change in a call
- audio-volume-set-source — audio input volume change
- audio-volume-set-sink — audio output volume change
Subscribe to an event
events subscribe call-end
Response: events subscribe call-end OK
Unsubscribe from an event
events unsubscribe call-end
Response: events unsubscribe call-end OK
Example of an incoming call with answer and hang-up
[event] call-incoming id type description caller_id
[event] call-incoming CIVn19KuvxbX11JwmX80q7wOZ9xp36DsZclK3kfSPxMkrqi6u4uM79gXYGxpP96u9GM370UcExQe88fO SIP SIP/192.168.80.222-e477f640 alexandr
[event] call-begin
[event] call-end