Yamaha CS-700 Integrators Reference Guide Revision 5.
Table of Contents 1 Overview ......................................................................................................................................... 8 2 USB Description ............................................................................................................................... 8 2.1 VID and PID .............................................................................................................................. 9 2.
enable-btn-camera................................................................................................................. 24 enable-btn-audio ................................................................................................................... 24 enable-btn-volume................................................................................................................. 25 enable-btn-bluetooth .......................................................................................
ringer-volume ........................................................................................................................ 50 5.2.2.2 Audio Statuses ............................................................................................................ 50 speaker-mute......................................................................................................................... 50 mute .................................................................................................
bt-pair-timeout ...................................................................................................................... 70 bt-call-autojoin....................................................................................................................... 71 bt-auto-unpair-on-disconnect ................................................................................................ 71 5.2.4.2 Bluetooth Statuses ...............................................................................
vlan-id .................................................................................................................................... 91 ntp1 ....................................................................................................................................... 91 ntp2 ....................................................................................................................................... 92 ntp3 ...........................................................................
ice-max-hosts ....................................................................................................................... 119 ice-no-rtcp ........................................................................................................................... 119 use-turn ............................................................................................................................... 120 turn-srv ....................................................................................
1 Overview The Yamaha CS-700 provides standard USB 3.0 and USB 2.0 communication links to a host processor (PC). It also provides an IP interface for management and VoIP calling. This guide describes the interfaces that hosts and external clients can use to manage and monitor the CS-700.
2.1 VID and PID The CS-700 Vendor IDs (VID) and Product IDs (PID) for each component are shown below. Component HUB USB v3.1 HUB USB v2.0 Audio Camera VID 0x0499 0x0499 0x0499 0x0499 PID 0x4031 0x4033 0x4030 0x4032 Comment USB v3.1 port USB v2.0 port Audio Class Video Class 2.2 Interface Definitions for the USB HUB Component The USB HUB component will enumerate to the host as a Universal Serial Bus controller. It will be displayed within the Host’s Device Manager as two devices: a USB 3.
Description Mic Mute States Mic Mute Mic Unmute Speaker Volume Gain Speaker volume Speaker Volume Control Volume Up Volume Down Mic Mute States Mute Unmute Call Control Off Hook (answer) On Hook (hang up) Hold Resume System Control Restart System Description Mic Mute States Mute Unmute Call States Ringing (incoming call) In Progress On Hold Ended Description Endpoint/ Report ID Report Value ep0 / 0x06 ep0 / 0x06 0x00 0x01 Control Transfer from Host Control Transfer from Host ep0 / 0x02 value To CS-7
The speaker volume can be controlled from the device by using the volume up/down cap-touch buttons on the base unit. The speaker volume range is 1 to 18. The host range is greater. In order to sync volume with the host, the device range is mapped to the host range. When the volume is changed from the device, the device sends one or more volume up/down reports to the host to achieve the best match based on the mapping.
Description Video Control ID Zoom PanTilt Roll Exposure Privacy Video Processing ID Backlight Brightness Contrast Saturation Sharpness Hue Gamma Flicker 2.4.
3 IP Interface Integrators wanting to communicate programmatically with the CS-700 for device management or operational control may use the CS-700 IP Management Interface. Use of the Yamaha Dialer Application that runs on an Android based tablet is described in the CS-700 Operations Guide. The interface supports these features: • • • Connect to a device via IP Transmit API commands Receive API responses and asynchronous notifications The API commands are described in section 5, API Command Reference.
echo Description: This will make sure the users of the CLI can see what they are typing by allowing commands to be echoed back. Property Actions: set Command Definition: Action set Definition set echo <0|1> Parameters: Parameter 0 1 Description Turn off screen echo Turn on screen echo CLI Format Examples: set echo 1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.
4.1 USB Library Reference This section describes the CS-700 Management Library's C interface. The header file is distributed with the CS-700 SDK. CsDevComm_Mode enum Description: Enumeration of USB connections type. The client should specify the connection type, Auto, HID, or Bulk, at the start of a session. Auto will select Bulk if available otherwise HID. Bulk is preferable when upgrading firmware.
Type 0xFF Description Device disconnected devDetach Description: Disconnect session. Syntax: EXPORT void __cdecl devDetach(void); Return Values: Value -1 0 Description General error Success isConnected Description: Get the USB connection status. Syntax: EXPORT int __cdecl isConnected(void); Return Values: Value -1 0 1 2 Description General error Not connected Connected HID Conned Bulk coreCliCmd Description: Send a CLI-format command to the device.
rsp len Pointer to response string Bytes available in response string Return Values: Value Description General failure Success -1 0 notifCtrl Description: Enable/disable notifications and register a callback function to handle CLI-format notifications. The notifications are defined in section 5, API Command Reference. Notifications are automatically disabled if device is disconnected.
nPercent Callback function parameter: Percent completion. A value of -1 indicates an upgrade error. Return Values: Value -1 0 Description General failure Success downloadLogs Description: Download a zipped log file to the specified directory.
import_config_ callback_t nPercent filepath Pointer to callback function to handle import progress notifications Callback function parameter: Percent completion. A value of -1 indicates an import error. Callback function parameter: Returned name of downloaded config file. Return Values: Value -1 0 Description General failure Success exportConfig Description: Export the CS-700 configuration settings to an XML file on the host.
The API is organized by functional Category, such as Audio and Camera, and within each category are listed the properties, status items and commands that are available for that category. Notifications are identified with their corresponding property or status item. The table below describes the command syntax. <"call-status"> <0|1|2> <0..
Description: Product name. Read-only set at manufacturing. Property Actions: get Command Definition: Action get response Definition get product val product <"name"> Parameters: Parameter Description String. Product name. Valid values are CS-700 and CS-700-SP name CLI Format Examples: get product val product CS-700 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 base-sernum Description: Query product serial number. Read-only set at manufacturing.
Description: Is VoIP supported on the device. This capability is set at the factory and cannot be changed. Property Actions: get Command Definition: Action get response Definition get voip-capable val voip-capable <0|1> Parameters: Parameter Description Device does not support VoIP Device does support VoIP 0 1 CLI Format Examples: get voip-capable val voip-capable 0 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 base-ver Description: Query product version.
systemname Description: Specifies the system name. Property Actions: set, get, notify Default Value: Product name concatenated with the MAC address Command Definition: Action get response set notify Definition get systemname val systemname <"system-name"> set systemname <"system-name"> notify sys.
CLI Format Examples: set md5-password 5735c3a7aa6ffcfe6ab123835584db75 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 enable-btn-camera Description: Enable/disable the camera button on the main unit. Property Actions: set, get, notify Default Value: 1 Command Definition: Action get response set notify Definition get enable-btn-camera val enable-btn-camera <0|1> set enable-btn-camera <0|1> notify sys.
Action get response set notify Definition get enable-btn-audio val enable-btn-audio <0|1> set enable-btn-audio <0|1> notify sys.enable-btn-audio <0|1> Parameters: Parameter Description Disable button Enable button 0 1 CLI Format Examples: get enable-btn-audio val enable-btn-audio 1 set enable-btn-audio 1 notify sys.enable-btn-audio 1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 enable-btn-volume Description: Enable/disable the speaker volume buttons on the main unit.
notify sys.enable-btn-volume 1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 enable-btn-bluetooth Description: Enable/disable the Bluetooth button on the main unit. Property Actions: set, get, notify Default Value: 1 Command Definition: Action get response set notify Definition get enable-btn-bluetooth val enable-btn-bluetooth <0|1> set enable-btn-bluetooth <0|1> notify sys.
response set notify val enable-led-call <0|1> set enable-led-call <0|1> notify sys.enable-led-call <0|1> Parameters: Parameter Description Disable LED Enable LED 0 1 CLI Format Examples: get enable-led-call val enable-led-call 1 set enable-led-call 1 notify sys.enable-led-call 1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 region Description: Region in which device is operating, setting by index.
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 Germany Hong Kong India Israel Italy Japan Malaysia Mexico New Zealand Singapore South Africa Taiwan United Kingdom USA Venezuela CLI Format Examples: get region val region 23 set region 23 notify sys.region 23 Supported Products: CS700-SP Available in API Version: 1.1 recent-call-enabled Description: Enables or disable the Recent Calls list.
get recent-call-enabled val recent-call-enabled 1 set recent-call-enabled 1 notify sys.recent-call-enabled 1 Supported Products: CS700-SP Available in API Version: 1.1 require-https Description: –Specify if HTTPS is required on Web UI login. Property Actions: set, get, notify Default Value: 0 Command Definition: Action get response set notify Definition get require-https val require-https <0|1> set require-https <0|1> notify sys.
Command Definition: Action get response set notify Definition get power-saving-mode val power-saving-mode <0|1> set power-saving-mode <0|1> notify sys.power-saving-mode <0|1> Parameters: Parameter Description Power save mode is off Power save mode is on 0 1 CLI Format Examples: get power-saving-mode val power-saving-mode 1 set power-saving-mode 1 notify sys.power-saving-mode 1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.
get power-saving-time val power-saving-time 20 set power-saving-time 20 notify sys.power-saving-time 20 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 auto-deploy Description: Enable auto provisioning server. Property Actions: set, get, notify Default Value: 1 Command Definition: Action get response set notify Definition get auto-deploy val auto-deploy <0|1> set auto-deploy <0|1> notify sys.
Default Value: 1 Command Definition: Action get response set notify Definition get enable-deploy val enable-deploy <0|1> set enable-deploy <0|1> notify sys.enable-deploy <0|1> Parameters: Parameter Description Disable provisioning Enable provisioning 0 1 CLI Format Examples: get enable-deploy val enable-deploy 1 set enable-deploy 1 notify sys.enable-deploy 1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.
get provisioning-interval val provisioning-interval 1440 set provisioning-interval 1440 notify sys.provisioning-interval 1440 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 snmp-enable Description: Enable or disable SNMP support. Property Actions: set, get, notify Default Value: 0 Command Definition: Action get response set notify Definition get snmp-enable val snmp-enable <0|1> set snmp-enable <0|1> notify sys.
Default Value: public Command Definition: Action get response set notify Definition get snmp-community val snmp-community <"community"> set snmp-community <"community"> notify sys.snmp-community <"community"> Parameters: Parameter community Description Read-only community string CLI Format Examples: get snmp-community val snmp-community it-support set snmp-community it-support notify sys.snmp-community it-support Supported Products: CS700-AV, CS700-SP Available in API Version: 1.
set snmp-contact-name Jessica Taylor notify sys.snmp-contact-name Jessica Taylor Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 snmp-device-location Description: Specifies the location of the device for informational purposes. Property Actions: set, get, notify Command Definition: Action get response set notify Definition get snmp-device-location val snmp-device-location <"location"> set snmp-device-location <"location"> notify sys.
notify notify sys.dialer-connection-mode Parameters: Parameter ip rc disconnected Description Connected via IP dialer Connected via Room Control Dialer is not connected The following table show the state of dialer-connection-mode after an action from the dialer or from the CLI.
get snmp-address val snmp-address <"address"> set snmp-address <"address"> notify sys.snmp-address <"address"> get response set notify Parameters: Parameter Description String. IP address or DNS name. Leave blank to disable traps. address CLI Format Examples: get snmp-address val snmp-address 200.200.210.152 set snmp-address 200.200.210.152 notify sys.snmp-address 200.200.210.152 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.
notify sys.verbose-log-enabled 0 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 ui-mask Description: Enable or disable menus in dialer via a bit mask. Property Actions: set, get, notify Default Value: 0 Command Definition: Action get response set notify Definition get ui-mask val ui-mask <”bit mask”> set ui-mask <”bit mask”> notify sys.
5.2.1.2 System Statuses usb-conn-status Description: Query USB connection status. Property Actions: get, notify Command Definition: Action get response notify Definition get usb-conn-status val usb-conn-status <0|1> notify sys.usb-conn-status <0|1> Parameters: Parameter 0 1 Description USB is not connected. USB is connected. CLI Format Examples: get usb-conn-status val usb-conn-status 1 notify sys.usb-conn-status 1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.
Failed Flashing WaitingCallEnd Rebooting Upgrade failed. Writing upgrade to flash memory. If any call is active, upgrade suspended until call ends. Upgrade complete, rebooting system. CLI Format Examples: get upgrade-status val upgrade-status Flashing notify sys.upgrade-status Flashing Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 camera-upgrade-status Description: Indicates the camera module upgrade status.
Description: System standby status. Property Actions: get, notify Command Definition: Action get response notify Definition get power-saving-status val power-saving-status <0|1> notify sys.power-saving-status <0|1> Parameters: Parameter 0 1 Description Not in standby In standby CLI Format Examples: get power-saving-status val power-saving-status 0 notify sys.power-saving-status 0 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.
Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 usb-aud-tx-status Description: Query state of USB TX audio stream (TX audio being sent, stopped). Property Actions: get, notify Command Definition: Action get response notify Definition get usb-aud-tx-status val usb-aud-tx-status <0|1> notify sys.
Available in API Version: 1.0 restart Description: Restart system. Command Definition: Action execute Parameters: Definition restart None CLI Format Examples: restart Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 set reset-setting Description: Reset settings by category.
5.2.2 5.2.2.1 Audio Audio Properties eq Description: EQ setting used to adjust the speaker frequencies to your preference for the room and the types of calls. Property Actions: set, get, notify Default Value: 1 Command Definition: Action get response set notify Definition get eq val eq <1|2|3> set eq <1|2|3> notify audio.eq <1|2|3> Parameters: Parameter Description Voice Bass boost Treble boost 1 2 3 CLI Format Examples: get eq val eq 1 set eq 1 notify audio.
Command Definition: Action get response set notify Definition get high-pass-filter val high-pass-filter <0..4> set high-pass-filter <0..4> notify audio.high-pass-filter <0..4> Parameters: Parameter Description None 110 Hz 140 Hz 175 Hz 225 Hz 0 1 2 3 4 CLI Format Examples: get high-pass-filter val high-pass-filter 0 set high-pass-filter 0 notify audio.high-pass-filter 0 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.
CLI Format Examples: get analog-audio-in-mode val analog-audio-in-mode 0 set analog-audio-in-mode 0 notify audio.analog-audio-in-mode 0 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 analog-audio-in-gain Description: For the TV audio in port, if analog-audio-in-mode is manual, then this is the gain value in dB. This value can be increased or decreased by 0.5dB. Property Actions: set, get, notify Default Value: 4.
Property Actions: set, get, notify Default Value: 0 Command Definition: Action get response set notify Definition get wireless-omni-mic val wireless-omni-mic <0|1> set wireless-omni-mic <0|1> notify audio.wireless-omni-mic <0|1> Parameters: Parameter Description Disable wireless omni-directional microphone Enable wireless omni-directional microphone 0 1 CLI Format Examples: get wireless-omni-mic val wireless-omni-mic 0 set wireless-omni-mic 1 notify audio.
CLI Format Examples: get wireless-direct-mic val wireless-direct-mic 0 set wireless-direct-mic 1 notify audio. wireless-direct-mic 1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.3 wireless-lapel-mic Description: Enables additional audio processing of extension wireless lapel microphones.
Default Value: 13 Command Definition: Action get response set notify Definition get speaker-volume val speaker-volume <1..18> set speaker-volume <1..18> notify audio.speaker-volume <1..18> Parameters: Parameter Description Volume setting 1..18 CLI Format Examples: get speaker-volume val speaker-volume 12 set speaker-volume 12 notify audio.speaker-volume 12 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 ring-tone Description: VoIP ring-tone selection.
set ring-tone 0 notify audio.ring-tone 0 Supported Products: CS700-SP Available in API Version: 1.1 ringer-volume Description: Property Actions: Configure VoIP ringer volume. set, get, notify Default Value: 13 Command Definition: Action get response set notify Definition get ringer-volume val ringer-volume <1..18> set ringer-volume <1..18> notify audio.ringer-volume <1..18> Parameters: Parameter Description Ringer volume level 1..
Action get response set notify Definition get speaker-mute val speaker-mute <0|1> Set speaker-mute <0|1> notify audio.speaker-mute <0|1> Parameters: Parameter Description Speaker is not muted Speaker is muted 0 1 CLI Format Examples: get speaker-mute val speaker-mute 1 set speaker-mute 1 notify audio.speaker-mute 1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.3 mute Description: Mute microphones.
notify audio.mute 0 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 mic-conn-status Description: Property Actions: Query external mic connection status. get, notify Command Definition: Action get response notify Definition get mic-conn-status val mic-conn-status <”mic_number”> notify audio.
val camera-ptz-home <"pan"> <"tilt"> <"zoom"> set camera-ptz-home <"pan"> <"tilt"> <"zoom"> notify camera.camera-ptz-home <"pan"> <"tilt"> <"zoom"> response set notify Parameters: Parameter Description Pan setting (default value is 0) Tilt setting (default value is 0) Zoom setting (default value is 100) -30..30 -18..18 100..400 CLI Format Examples: get camera-ptz-home val camera-ptz-home 0 0 100 set camera-ptz-home 0 0 100 notify camera.
Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 camera-image-defaults Description: Camera image default settings. These are Backlight, Brightness, Contrast, Saturation, Sharpness, Hue, and Gamma.
Description: Query camera state. Property Actions: get, notify Command Definition: Action get response notify Definition get camera-status val camera-status notify camera.
open closed USB video stream is open USB video stream is closed CLI Format Examples: get camera-stream val camera-stream open notify camera.camera-stream open Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 camera-door Description: Query state of camera door. Property Actions: get, notify Command Definition: Action get response notify Definition get camera-door val camera-door notify camera.
val camera-mute <0|1> set camera-mute <0|1> notify camera.camera-mute <0|1> response set notify Parameters: Parameter Description Camera video is not muted Camera video is muted 0 1 CLI Format Examples: get camera-mute val camera-mute 0 set camera-mute 0 notify camera.camera-mute 0 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 camera-pan Description: Camera's digital pan setting. Camera can only be panned when zoomed in.
Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 camera-tilt Description: Camera's digital tilt setting. Camera can only be tilted when zoomed in. Property Actions: set, get, notify Default Value: 0 Command Definition: Action get response set notify Definition get camera-tilt val camera-tilt <-18..18> set camera-tilt <-18..18> notify camera.camera-tilt <-18..18> Parameters: Parameter -18..
notify camera.camera-zoom <100..400> notify Parameters: Parameter Description Zoom setting 100..400 CLI Format Examples: get camera-zoom val camera-zoom 100 set camera-zoom 100 notify camera.camera-zoom 100 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 camera-backlight Description: Backlight compensation for camera.
Available in API Version: 1.1 camera-brightness Description: Camera Brightness level Property Actions: set, get, notify Default Value: 125 Command Definition: Action get response set notify Definition get camera-brightness val camera-brightness <0..250> set camera-brightness <0..250> notify camera.camera-brightness <0..250> Parameters: Parameter 0..250 Description Camera Brightness level.
set notify set camera-contrast <60..140> notify camera.camera-contrast <60..140> Parameters: Parameter 60..140 Description Camera Contrast level. CLI Format Examples: get camera-contrast val camera-contrast 110 set camera-contrast 110 notify camera.camera-contrast 110 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.
Available in API Version: 1.1 camera-sharpness Description: Camera Sharpness level Property Actions: set, get, notify Default Value: 85 Command Definition: Action get response set notify Definition get camera-sharpness val camera-sharpness <0..255> set camera-sharpness <0..255> notify camera.camera-sharpness <0..255> Parameters: Parameter Description Camera Sharpness level. 0..255 CLI Format Examples: get camera-sharpness val camera-sharpness 100 set camera-sharpness 100 notify camera.
Parameters: Parameter Description Camera Hue level. 0..180 CLI Format Examples: get camera-hue val camera-hue 100 set camera-hue 100 notify camera.camera-hue 100 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.1 camera-gamma Description: Camera Gamma level Property Actions: set, get, notify Default Value: 255 Command Definition: Action Get Response Set Notify Definition get camera-gamma val camera-gamma <1..255> set camera-gamma <1..255> notify camera.camera-gamma <1..
cam-save-as-default Description: Save the camera's current PTZ settings as the default values. Command Definition: Action execute Parameters: Definition cam-save-as-default None CLI Format Examples: cam-save-as-default Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 cam-apply-defaults Description: Apply the camera's default PTZ settings.
Parameters: None CLI Format Examples: cam-image-save-as-default Supported Products: CS700-AV, CS700-SP Available in API Version: 1.1 cam-image-apply-defaults Description: Apply the camera's default Backlight, Brightness, Contrast, Saturation, Sharpness, Hue, and Gamma settings. These settings are also automatically applied when the device detects that the upstream USB connection has been established, either at startup or after a USB disconnection.
Description: Zoom out the camera by one level. Command Definition: Action Execute Notify Parameters: Definition cam-zoom-out notify camera.zoom <100..400> None CLI Format Examples: cam-zoom-out notify camera.zoom 100 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.1 cam-pan-left Description: Pan the camera left by one level. Command Definition: Action Execute Notify Parameters: Definition cam-pan-left notify camera.pan <-30..
Supported Products: CS700-AV, CS700-SP Available in API Version: 1.1 cam-tilt-up Description: Tilt the camera up by one level. Command Definition: Action Execute Notify Parameters: Definition cam-tilt-up notify camera.tilt <-18..18> None CLI Format Examples: cam-tilt-up notify camera.tilt 8 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.1 cam-tilt-down Description: Tilt the camera down by one level.
Default Value: 1 Command Definition: Action get response set notify Definition get bt-enable val bt-enable <0|1> set bt-enable <0|1> notify bt.bt-enable <0|1> Parameters: Parameter 0 1 Description Disable Enable CLI Format Examples: get bt-enable val bt-enable 0 set bt-enable 0 notify bt.bt-enable 0 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 bt-mac Description: Get the Bluetooth device's MAC address advertised over the air. This is read-only and set in manufacturing.
Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 bt-name Description: The Bluetooth basic-rate device name advertised over the air. Property Actions: set, get, notify Default Value: The product name concatenated with the Bluethooth’s MAC address - i.e., "Yamaha CS-700 " + last 2 bytes of the Bluetooth’s MAC address. Command Definition: Action get response set notify Definition get bt-name val bt-name <"name"> set bt-name <"name"> notify bt.
notify notify bt.bt-pin <"pin"> Parameters: Parameter Description 4-digit string pin CLI Format Examples: get bt-pin val bt-pin 0000 set bt-pin 0000 notify bt.bt-pin 0000 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 bt-pair-timeout Description: Bluetooth basic-rate pairing timeout in seconds. After this time, the pairing mode will stop. A value of 0 indicates no timeout.
Available in API Version: 1.4 bt-call-autojoin Description: Allow a Bluetooth call on the paired and linked Bluetooth device to automatically join a USB based conference if there is no dialer control app in use. Property Actions: set, get, notify Default Value: 0 Command Definition: Action get response set notify Definition get bt-call-autojoin val bt-call-autojoin <0|1> set bt-call-autojoin <0|1> notify bt.
response set notify val bt-auto-unpair-on-disconnect <0|1> set bt-auto-unpair-on-disconnect <0|1> notify bt. bt-auto-unpair-on-disconnect <0|1> Parameters: Parameter 0 1 Description Bluetooth auto-unpair on disconnect disabled Bluetooth auto-unpair on disconnect enabled CLI Format Examples: get bt-auto-unpair-on-disconnect val bt-auto-unpair-on-disconnect 0 set bt-auto-unpair-on-disconnect 0 notify bt.bt-auto-unpair-on-disconnect 0 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.
get bt-status val bt-status Connected notify bt.bt-status Connected Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 bt-paired-list Description: Get a list of paired Bluetooth basic-rate devices. Return space-separated MAC address and name pairs. Property Actions: get Command Definition: Action get response Definition get bt-paired-list val bt-paired-list <"mac"> <"name"> [<"mac"> <"name">]+ Parameters: Parameter Mac name Description MAC address of paired device. String.
Parameter mac name Description MAC address of connected device. String. Name of connected device. CLI Format Examples: get bt-connected val bt-connected D4:B3:77:EF:31:94 ADR6301 a2dp,hsp notify bt.bt-connected D4:B3:77:EF:31:94 SAMSUNG-G925V Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 5.2.4.3 Bluetooth Commands bt-pair Description: Initiate Bluetooth pairing mode from the device in order to pair a phone.
All Remove all paired devices CLI Format Examples: bt-unpair all Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 bt-disconnect Description: Disconnect the connected Bluetooth device. Command Definition: Action Execute Parameters: Definition bt-disconnect None CLI Format Examples: bt-disconnect Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 nfc-enable Description: Enable/disable NFC and the NFC logo LED on the main unit.
val nfc-enable 1 set nfc-enable 1 notify bt.nfc-enable 1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.1 5.2.5 5.2.5.1 Call Call Statuses status Description: Query a call status. Property Actions: get, notify Command Definition: Action Get Response Notify Definition get status <1..3|usb|bt> val status <1..3|usb|bt> <"call-status"> notify call.status <1..
active idle incoming inactive connected onhold connected-inconf BT Calls active idle incoming inactive connected onhold connected-inconf USB audio is active. Initialization state. Incoming USB call signal is received from host. USB audio is not active. Call is connected. USB audio is on hold. Call is in a conference. BT audio is active. Initialization state. Incoming BT call signal is received from connected phone. BT audio is not active. Call is connected. BT audio is on hold. Call is in a conference.
get status-all val status-all line1:disabled line2:disabled line3:disabled bt:idle usb:idle Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0, VoIP Available in API Version: 1.1 call-info Description: Query call information with given call id. Property Actions: get Command Definition: Action get response Definition get call-info <1..3, bt, usb> val call-info <1..
Parameter Description VoIP line 1 VoIP line 2 VoIP line 3 (used for transfer) Caller's phone number 1 2 3 number CLI Format Examples: get number 1 val number 1 7823 Supported Products: CS700-SP Available in API Version: 1.1 caller Description: Query a caller name. Property Actions: get Command Definition: Action get response Definition get caller <1..3> val caller <1..
Action get response Definition get start-time <1..3> val start-time <1..3> <"time"> Parameters: Parameter 1 2 3 time Description VoIP line 1 VoIP line 2 VoIP line 3 (used for transfer) HH:MM:SS in 24-hour time CLI Format Examples: get start-time 1 val start-time 1 13:22:41 Supported Products: CS700-SP Available in API Version: 1.1 codec Description: Query call codec. Property Actions: get Command Definition: Action get response Definition get codec <1..3> val codec <1..
Supported Products: CS700-SP Available in API Version: 1.1 call-quality Description: Query call quality. Note: The response is a comma separate list of values. Property Actions: get Command Definition: Action get response Definition get call-quality <1..3> val call-quality <1..
5.2.5.2 Call Commands dial Description: Dial of VoIP call with the given number. Command Definition: Action execute Definition dial <"voip-line-id"> <"number"> Parameters: Parameter 1 2 3 Number Description VoIP line 1 VoIP line 2 VoIP line 3 (used for transfer) VoIP number to dial CLI Format Examples: dial 1 7823 Supported Products: CS700-SP Available in API Version: 1.1 answer Description: Answer the given call. Command Definition: Action execute Definition answer <1..
Command Definition: Action execute Definition hangup <1..3|usb|bt> Parameters: Parameter Description Line ID of call to be hung up line-id <1..3|usb|bt> CLI Format Examples: hangup 1 Supported Products: CS700-AV, CS700-SP, Available in API Version: 1.0, VoIP(Line ID) Available in API Version: 1.1 hold Description: Hold the given call. Command Definition: Action execute Definition hold <1..2|usb|bt|all> Parameters: Parameter line-id <1..
Parameter line-id <1..2|usb|bt> Description Line ID of call to be resumed CLI Format Examples: resume 1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0, VoIP(Line ID) Available in API Version: 1.1 swap Description: Swap the source call with the target call, used for swapping held calls. Command Definition: Action execute Definition swap <"held-line-id"> <"active-line-id"> Parameters: Parameter held-line-id <1..2|usb|bt> active-line-id <1..
line-id2 <1..2|usb|bt> line-id3 <1..2|usb|bt> line-id4 <1..2|usb|bt> mix_state 0 1 Line ID2 of call to be mixed or not mixed Line ID3 of call to be mixed or not mixed [optional] Line ID4 of call to be mixed or not mixed [optional] Separate lines (not mixed) Join lines (mix) CLI Format Examples: Join (mix) only VoIP lines 1 and 2 join 1 1 2 1 usb 0 bt 0 join 1 1 2 1 Separate (not mixed) all calls from a conference join 1 0 2 0 usb 0 bt 0 Supported Products: CS700-SP Available in API Version: 1.
Command Definition: Action execute Definition play ring-tone <0..5> Parameters: Parameter 0..5 Description Ring-tone index CLI Format Examples: play ring-tone 0 Supported Products: CS700-SP Available in API Version: 1.1 5.2.6 5.2.6.1 Network Network Properties mac Description: Main unit's MAC address. Read-only value set at manufacturing.
Property Actions: set, get, notify Default Value: 1 Command Definition: Action get response set notify Definition get dhcp val dhcp <0|1> set dhcp <0|1> notify net.dhcp <0|1> Parameters: Parameter 0 1 Description Disable DHCP Enable DHCP CLI Format Examples: get dhcp val dhcp 1 set dhcp 1 notify net.dhcp 1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 ip Description: Current IP Address assigned to the device.
get ip val ip 192.168.1.103 set ip 192.168.1.103 notify net.ip 192.168.1.103 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 subnet Description: Subnet Mask to determine the subnet to which the device belongs. Property Actions: set, get, notify Command Definition: Action get response set notify Definition get subnet val subnet <"subnet-address"> set subnet <"subnet-address"> notify net.subnet <"subnet-address"> Parameters: Parameter subnet-address Description String.
response set notify val gateway <"gateway-address"> set gateway <"gateway-address"> notify net.gateway <"gateway-address"> Parameters: Parameter gateway-address Description String. IP address. CLI Format Examples: get gateway val gateway 192.168.3.1 set gateway 192.168.3.1 notify net.gateway 192.168.3.1 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 dns1 Description: Address of the primary Domain Name System (DNS) server.
dns2 Description: Address of the secondary Domain Name System (DNS) server. Property Actions: set, get, notify Command Definition: Action get response set notify Definition get dns2 val dns2 <"dns-address"> set dns2 <"dns-address"> notify net.dns2 <"dns-address"> Parameters: Parameter Description String. IP address. dns-address CLI Format Examples: get dns2 val dns2 192.168.3.46 set dns2 192.168.3.46 notify net.dns2 192.168.3.46 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.
1 2 Disable VLAN. Switches off VLAN capabilities Automatically detect VLAN ID. should be used in environments that provide a Voice VLAN with automatic detection, in which case the device will determine the VLAN identifier and register in that network CLI Format Examples: get vlan val vlan 2 set vlan 2 notify net.vlan 2 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 vlan-id Description: The manually specified VLAN ID.
Description: Configure first NTP (Network Time Protocol) server address. Property Actions: set, get, notify Default Value: 0.pool.ntp.org Command Definition: Action get response set notify Definition get ntp1 val ntp1 <"ntp-address"> set ntp1 <"ntp-address"> notify net.ntp1 <"ntp-address"> Parameters: Parameter ntp-address Description String. IP address or URL or DNS name. CLI Format Examples: get ntp1 val ntp1 0.pool.ntp.org set ntp1 0.pool.ntp.org notify net.ntp1 0.pool.ntp.
ntp-address String. IP address or URL or DNS name. CLI Format Examples: get ntp2 val ntp2 1.pool.ntp.org set ntp2 1.pool.ntp.org notify net.ntp2 1.pool.ntp.org Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 ntp3 Description: Configure third NTP (Network Time Protocol) server address. Property Actions: set, get, notify Default Value: 2.pool.ntp.
Default Value: none Command Definition: Action get response set notify Definition get ntp4 val ntp4 <"ntp-address"> set ntp4 <"ntp-address"> notify net.ntp4 <"ntp-address"> Parameters: Parameter Description String. IP address or URL or DNS name. ntp-address CLI Format Examples: get ntp4 val ntp4 3.pool.ntp.org set ntp4 3.pool.ntp.org notify net.ntp4 3.pool.ntp.org Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 dot1x-enabled Description: Enables 802.
CLI Format Examples: get dot1x-enabled val dot1x-enabled 0 set dot1x-enabled 0 notify net.dot1x-enabled 0 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 dot1x-identity Description: Set a 802.1x authentication identity – required for MD5. Property Actions: set, get, notify Command Definition: Action get response set notify Definition get dot1x-identity val dot1x-identity <"user-name"> set dot1x-identity <"user-name"> notify net.
Action get response set notify Definition get dot1x-password val dot1x-password <"password"> set dot1x-password <"password"> notify net.dot1x-password <"password"> Parameters: Parameter password Description String. CLI Format Examples: get dot1x-password val dot1x-password 5321 set dot1x-password 5321 notify net.dot1x-password 5321 Supported Products: CS700-AV, CS700-SP Available in API Version: 1.0 5.2.6.2 Network Commands set net-commit Description: Apply network configuration changes.
Property Actions: set, get, notify Command Definition: Action get response set notify Definition get registrar val registrar <"address"> set registrar <"address"> notify voip.registrar <"address"> Parameters: Parameter address Description String. IP address or DNS name. CLI Format Examples: get registrar val registrar 200.200.210.150 set registrar 200.200.210.150 notify voip.registrar 200.200.210.150 Supported Products: CS700-SP Available in API Version: 1.
Parameters: Parameter Description String. IP address or DNS name. address CLI Format Examples: get registrar-backup val registrar-backup 200.200.210.151 set registrar-backup 200.200.210.151 notify voip.registrar-backup 200.200.210.151 Supported Products: CS700-SP Available in API Version: 1.1 realm Description: Realm of the credential to authenticate against the VoIP server.
proxy Description: The outbound SIP proxy server's IP address or name. If there are multiple SIP proxies, separate the addresses by a comma. Also note that if the allow strict routing option is set and you have a SIP proxy that is configured for loose routing, add the designation after the proxy's address, for example, '10.134.129.101;lr'.
Parameters: Parameter Description No proxy Outbound only Acc only All 0 1 2 3 CLI Format Examples: get reg-use-proxy val reg-use-proxy 0 set reg-use-proxy 0 notify voip.reg-use-proxy 0 Supported Products: CS700-SP Available in API Version: 1.1 user Description: SIP username for the account used to authenticate with the SIP registrar and proxies. Required for VoIP support.
password Description: SIP password for the account used to authenticate with the SIP registrar and proxies. Required for VoIP call support. Property Actions: set, get, notify Command Definition: Action get response set notify Definition get password val password <"password"> set password <"password"> notify voip.password <"password"> Parameters: Parameter password Description String. SIP user password. CLI Format Examples: get password val password 1234 set password 1234 notify voip.
id String. SIP ID. CLI Format Examples: get id val id 7824 set id 7824 notify voip.id 7824 Supported Products: CS700-SP Available in API Version: 1.1 name Description: VoIP Display Name. The Display Name is shown when an outbound call is made. If no Display Name is provided, the User name will be used. Please note that the IP PBX might override the display name sent by the device and replace it with names configured in the PBX.
Default Value: 60 Command Definition: Action get response set notify Definition get reg-timeout val reg-timeout <1..604800> set reg-timeout <1..604800> notify voip.reg-timeout <1..604800> Parameters: Parameter Description Registration timeout in seconds 1..604800 CLI Format Examples: get reg-timeout val reg-timeout 60 set reg-timeout 60 notify voip.reg-timeout 60 Supported Products: CS700-SP Available in API Version: 1.
get rereg-delay val rereg-delay 300 set rereg-delay 300 notify voip.rereg-delay 300 Supported Products: CS700-SP Available in API Version: 1.1 use-timer Description: Specify the preference for using SIP session keep-alive timers. During a SIP session, if SIP session timers are active, the SIP User Agent (UA) periodically sends INVITE or UPDATE requests (also called refresh requests) to keep the SIP session alive. The interval and use of the keep-alive is determined at call negotiation.
Available in API Version: 1.1 timer-se Description: Property Actions: The expiration period (seconds) is the interval at which the phone will consider the SIP session timed out if it does not receive a refresh message from the remote phone. At call negotiation, the nodes will negotiate the expiration period to be used for the session. If the negotiated value is less than the session timer’s minimum expiration, then the session timer minimum expiration is used instead. It is measured in seconds.
get timer-min-se val timer-min-se <1..604800> set timer-min-se <1..604800> notify voip.timer-min-se <1..604800> get response set notify Parameters: Parameter Description Minimum session timer value in seconds 1..604800 CLI Format Examples: get timer-min-se val timer-min-se 90 set timer-min-se 90 notify voip.timer-min-se 90 Supported Products: CS700-SP Available in API Version: 1.1 use-100rel Description: Implements reliable SIP provisional responses.
val use-100rel 0 set use-100rel 0 notify voip.use-100rel 0 Supported Products: CS700-SP Available in API Version: 1.1 auto-update-nat Description: Configure whether SIP traversal behind NAT is disabled. Used for device behind a symmetric NAT (Network Address Translation). When enabled, the device will keep track of the public IP address from the response of the REGISTER request.
Property Actions: set, get, notify Default Value: 0 Command Definition: Action get response set notify Definition get dtmf-method val dtmf-method <0|1|2> set dtmf-method <0|1|2> notify voip.dtmf-method <0|1|2> Parameters: Parameter Description RTP -- RFC2833 SIP INFO In-band 0 1 2 CLI Format Examples: get dtmf-method val dtmf-method 0 set dtmf-method 0 notify voip.dtmf-method 0 Supported Products: CS700-SPed to specify the dynamic RTP payload type for DTMF signaling via RTP.
set dtmf-rtp-payload-type 0 notify voip. dtmf-rtp-payload-type 0 Supported Products: CS700-SP Available in API Version: 1.1 media-onhold-method Description: Property Actions: The Media on Hold method setting allows switching the Media on Hold behavior between the different RFC definitions. set, get, notify Default Value: 0 Command Definition: Action get response set notify Definition get media-onhold-method val media-onhold-method <0|1> set media-onhold-method <0|1> notify voip.
Default Value: 0 Command Definition: Action get response set notify Definition get use-srtp val use-srtp <0|1|2> set use-srtp <0|1|2> notify voip.
CLI Format Examples: get rtp-port val rtp-port 4000 set rtp-port 4000 notify voip.rtp-port 4000 Supported Products: CS700-SP Available in API Version: 1.1 set-qos Description: Option to enable QoS (Quality of Service) tagging for SIP and media. For layer 3, at the Internet layer, the DiffServ (Differentiated Services) precedence level is Class 3. The Differentiated Services Code Point (DSCP) in the IP header is set to 24 (0x18). For layer 2, IEEE 802.1p tagging is supported.
Description: Transport that will be used for SIP messages. Property Actions: set, get, notify Default Value: 0 Command Definition: Action get response set notify Definition get udp-tcp-selection val udp-tcp-selection <0|1> set udp-tcp-selection <0|1> notify voip.udp-tcp-selection <0|1> Parameters: Parameter 0 1 Description UDP TCP CLI Format Examples: get udp-tcp-selection val udp-tcp-selection 0 set udp-tcp-selection 0 notify voip.
1024..65535 Port number CLI Format Examples: get local-port val local-port 5060 set local-port 5060 notify voip.local-port 5060 Supported Products: CS700-SP Available in API Version: 1.1 ip-addr Description: Configure optional address to advertise as the address of this transport. Can specify any address or hostname for this field. For example, it can point to the public address of a NAT router where port mappings have been configured for SIP..
Description: Optional address where the socket should be bound to. This option should only be used to selectively bind the socket to a particular interface, and should not be used to set the published address of a transport – the ip-addr attribute should be used for that purpose. Property Actions: set, get, notify Command Definition: Action get response set notify Definition get bound-addr val bound-addr <"ip-address"> set bound-addr <"ip-address"> notify voip.
Parameter Description Disable suppressing subscription Enable suppressing subscription 0 1 CLI Format Examples: get no-refer-sub val no-refer-sub 0 set no-refer-sub 0 notify voip.no-refer-sub 0 Supported Products: CS700-SP Available in API Version: 1.1 min-size Description: Use compact SIP message format. The SIP protocol specifies that header field names can be in the full name form or in the abbreviated form.
Supported Products: CS700-SP Available in API Version: 1.1 allow-strict Description: Allow strict routing for SIP registration proxies. By default, proxies specified for SIP registration will be configured as loose-routing proxies. The loose-routing designation will be automatically appended to each proxy address when the proxy is added to the SIP Route header. Older proxies may be strict-routing (see IETF RFC 2543), not supporting loose routing (see IETF RFC 3261).
Property Actions: set, get, notify Command Definition: Action get response set notify Definition get stun-srv val stun-srv <"stun-address"> set stun-srv <"stun-address"> notify voip.stun-srv <"stun-address"> Parameters: Parameter Description String. IP address, domain name, or host name, and optional port number. Separate multiple addresses by comma. stun-address CLI Format Examples: get stun-srv val stun-srv 10.123.145.15 set stun-srv 10.123.145.15 notify voip.stun-srv 10.123.145.
Parameter Description Disable ICE Enable ICE 0 1 CLI Format Examples: get use-ice val use-ice 0 set use-ice 0 notify voip.use-ice 0 Supported Products: CS700-SP Available in API Version: 1.1 ice-regular Description: ICE nomination method. When using ICE, select the preferred ICE Nomination Method. To validate candidate pairs (IP addresses and ports for the local and remote nodes), CS-700 sends STUN binding requests as part of the media connectivity tests.
set ice-regular 1 notify voip.ice-regular 1 Supported Products: CS700-SP Available in API Version: 1.1 ice-max-hosts Description: Property Actions: Maximum number of ICE host candidate. An ICE host candidate is an actual local transport address in the host. Host transport addresses are obtained by binding to attached network interfaces. These interfaces include both physical interfaces and virtual interfaces such as VPN.
Command Definition: Action Get Response Set Notify Definition get ice-no-rtcp val ice-no-rtcp <0|1> set ice-no-rtcp <0|1> notify voip.ice-no-rtcp <0|1> Parameters: Parameter Description Do not disable RTCP Keep RTCP disabled 0 1 CLI Format Examples: get ice-no-rtcp val ice-no-rtcp 0 set ice-no-rtcp 0 notify voip.ice-no-rtcp 0 Supported Products: CS700-SP Available in API Version: 1.1 use-turn Description: Enables the use of a TURN (Traversal Using Relay NAT) relay when using ICE.
CLI Format Examples: get use-turn val use-turn 0 set use-turn 0 notify voip.use-turn 0 Supported Products: CS700-SP Available in API Version: 1.1 turn-srv Description: TURN server domain name or hostname, and port. The format is either 'DOMAIN:PORT' or 'HOST:PORT' Property Actions: set, get, notify Command Definition: Action Get Response Set Notify Definition get turn-srv val turn-srv <"address"> set turn-srv <"address"> notify voip.
Action Get Response Set Notify Definition get turn-user val turn-user <"user-name"> set turn-user <"user-name"> notify voip.turn-user <"user-name"> Parameters: Parameter user-name Description String. CLI Format Examples: get turn-user val turn-user testuser set turn-user testuser notify voip.turn-user testuser Supported Products: CS700-SP Available in API Version: 1.1 turn-passwd Description: Password to authenticate against the TURN server.
Supported Products: CS700-SP Available in API Version: 1.1 turn-tcp Description: Property Actions: Configure whether to use TCP on TURN relay; otherwise use UDP. set, get, notify Default Value: 0 Command Definition: Action Get Response Set Notify Definition get turn-tcp val turn-tcp <0|1> set turn-tcp <0|1> notify voip.turn-tcp <0|1> Parameters: Parameter Description Do not use TCP; use UDP Use TCP 0 1 CLI Format Examples: get turn-tcp val turn-tcp 0 set turn-tcp 0 notify voip.
notify voip.codec1 <0..5> Notify Parameters: Parameter Description None G.722 G.711 u-law (PCMU) G.711 A-law (PCMA) G.726 G.729 0 1 2 3 4 5 CLI Format Examples: get codec1 val codec1 1 set codec1 1 notify voip.codec1 1 Supported Products: CS700-SP Available in API Version: 1.1 codec2 Description: Second highest prioritized codec. At least one codec different from “None” has to be selected in voip.codec1-voip.codec5.
CLI Format Examples: get codec2 val codec2 2 set codec2 2 notify voip.codec2 2 Supported Products: CS700-SP Available in API Version: 1.1 codec3 Description: Third highest prioritized codec. At least one codec different from “None” has to be selected in voip.codec1-voip.codec5. Property Actions: set, get, notify Default Value: 3 Command Definition: Action get response set notify Definition get codec3 val codec3 <0..5> set codec3 <0..5> notify voip.codec3 <0..
Description: Fourth highest prioritized codec. At least one codec different from “None” has to be selected in voip.codec1-voip.codec5. Property Actions: set, get, notify Default Value: 4 Command Definition: Action get response set notify Definition get codec4 val codec4 <0..5> set codec4 <0..5> notify voip.codec4 <0..5> Parameters: Parameter Description None G.722 G.711 u-law (PCMU) G.711 A-law (PCMA) G.726 G.729 0 1 2 3 4 5 CLI Format Examples: get codec4 val codec4 4 set codec4 4 notify voip.
response set notify val codec5 <0..5> set codec5 <0..5> notify voip.codec5 <0..5> Parameters: Parameter Description None G.722 G.711 u-law (PCMU) G.711 A-law (PCMA) G.726 G.729 0 1 2 3 4 5 CLI Format Examples: get codec5 val codec5 5 set codec5 5 notify voip.codec5 5 Supported Products: CS700-SP Available in API Version: 1.
val ptime 20 set ptime 20 notify voip.ptime 20 Supported Products: CS700-SP Available in API Version: 1.1 mwi Description: Enable displaying the message waiting indicator (MWI) on the device and enable receiving message waiting notifications from the PBX. The PBX must be configured to support voice mail for the registered user in order for this feature to work properly.
Action get response set notify Definition get vm-number val vm-number <"vm-number"> set vm-number <"vm-number"> notify voip.vm-number <"vm-number"> Parameters: Parameter Description String. VoIP voicemail number. vm-number CLI Format Examples: get vm-number val vm-number 7243 set vm-number 7243 notify voip.vm-number 7243 Supported Products: CS700-SP Available in API Version: 1.1 vm-count Description: Query VoIP voice mail count.
do-not-disturb Description: Property Actions: Configure do-not-disturb (DND) setting. set, get, notify Default Value: 0 Command Definition: Action get response set notify Definition get do-not-disturb val do-not-disturb <0|1> set do-not-disturb <0|1> notify voip.do-not-disturb <0|1> Parameters: Parameter Description Disable DND Enable DND 0 1 CLI Format Examples: get do-not-disturb val do-not-disturb 0 set do-not-disturb 0 notify voip.
Parameters: Parameter Description Disable auto-answer RESPONSE to send when answering 0 100..699 CLI Format Examples: get auto-answer val auto-answer 0 set auto-answer 0 notify voip.auto-answer 0 Supported Products: CS700-SP Available in API Version: 1.1 duration Description: Property Actions: Specifies the maximum VoIP call duration in minutes. When the call duration reaches the maximum duration, the call will be automatically terminated.
dial-plan Description: Specifies the VoIP dial plan string. See the User's Guide for a detailed description of dial plan settings. Property Actions: set, get, notify Command Definition: Action get response set notify Definition get dial-plan val dial-plan <"dial-plan"> set dial-plan <"dial-plan"> notify voip.dial-plan <"dial-plan"> Parameters: Parameter Description Dial plan string.
Parameters: Parameter 0 1 Description Disable Enable CLI Format Examples: get always-forwarding val always-forwarding 0 set always-forwarding 0 notify voip.always-forwarding 0 Supported Products: CS700-SP Available in API Version: 1.1 always-forwarding-num Description: Forward all incoming VoIP calls to the specified number.
Description: Enable or disable forwarding incoming calls to the specified number if the local phone is in 'Do Not Disturb' mode or if both lines are busy. Property Actions: set, get, notify Default Value: 0 Command Definition: Action get response set notify Definition get busy-forwarding val busy-forwarding <0|1> set busy-forwarding <0|1> notify voip.
fwd-number String. VoIP dialing number. CLI Format Examples: get busy-forwarding-num val busy-forwarding-num 7823 set busy-forwarding-num 7823 notify voip.busy-forwarding-num 7823 Supported Products: CS700-SP Available in API Version: 1.1 noanswer-forwarding Description: Enable or disable forwarding incoming VoIP calls to the specified number if the call is not answered within the duration specified in the 'noanswer-delay' attribute.
Description: Forward incoming VoIP calls to the specified number if the call is not answered within the duration specified in the 'noanswer-delay' attribute. Property Actions: set, get, notify Command Definition: Action get response set notify Definition get noanswer-forwarding-num val noanswer-forwarding-num <"fwd-number"> set noanswer-forwarding-num <"fwd-number"> notify voip.noanswer-forwarding-num <"fwd-number"> Parameters: Parameter Description String. VoIP dialing number.
CLI Format Examples: get noanswer-delay val noanswer-delay 10 set noanswer-delay 10 notify voip.noanswer-delay 10 Supported Products: CS700-SP Available in API Version: 1.1 5.2.7.2 VoIP Statuses registration Description: Query SIP registration status. Property Actions: get, notify Command Definition: Action get response notify Definition get registration val registration <0..999> notify voip.registration <0..
Command Definition: Action execute Definition set dtmf <"voip-line-id"> <"digit"> Parameters: Parameter 1 2 3 digit Description VoIP line 1 VoIP line 2 VoIP line 3 (used for transfer) dtmf digit, use - to stop previous DTMF digit CLI Format Examples: set dtmf 1 5 set dtmf 1 - Supported Products: CS700-SP Available in API Version: 1.1 set voip-commit Description: Apply voip configuration changes. You must send the "voip-commit" command to apply any changes to the VoIP settings.
When a device starts, it sends a request to the DHCP server for an IP address. In addition to the IP address, the device can query the DHCP server for additional information configured on the DHCP server. Options 66 and 150 provide the address or hostname of one or more HTTP, TFTP or FTP servers.
Sample enterprise configuration file Filename: enterprise.xml CS-700-2-6-0-294.bundle Sample department configuration file Filename: department.
sys.enable-btncamera BOOLEAN 0 : Disable button 1 : Enable button 1 Enable/disable the camera button on the main unit. sys.enable-btnaudio BOOLEAN 0 : Disable button 1 : Enable button 1 sys.enable-btnvolume BOOLEAN 0 : Disable button 1 : Enable button 1 sys.enable-btnbluetooth BOOLEAN 0 : Disable button 1 : Enable button 1 sys.enable-ledcall BOOLEAN 0 : Disable LED 1 : Enable LED 1 Enable/disable the microphone mute button on the main unit.
sys.provisioninginterval NUMBER 1..44640 : Provisioning interval in minutes 1440 (1 day) Specify the provisioning interval for the device, in minutes.. sys.snmp-enable BOOLEAN 0 : Disable SNMP 1 : Enable SNMP 0 Enable or disable SNMP support.. sys.snmpcommunity TEXT Read-only community string. public sys.snmpcontact-name TEXT Contact name. Specifies the SNMP readonly community string used for queries from the server and transmitted traps. Read-only indicates the authorization level.
audio.eq NUMBER 1 : Voice 2 : Bass boost 3 : Treble boost 1 audio.high-passfilter INDEXED_ OPTION 0 : None 1 : 110 Hz 2 : 140 Hz 3 : 175 Hz 4 : 225 Hz 0 audio.analogaudio-in-mode BOOLEAN 0 audio.analogaudio-in-gain NUMBER 0 : Automatic gain setting 1 : Manually specify gain setting -12.0..40.0 : Manual gain setting audio.wirelessomni-mic BOOLEAN 0 audio.wirelessdirect-mic BOOLEAN audio.wirelesslapel-mic BOOLEAN audio.
camera.cameraptz-home TEXT String format: <”pan”> <”tilt”> <”zoom”> pan: <-30..30> tilt: <-18..18> zoom: <100..400> 0 0 100 camera.cameraflicker NUMBER 1 : 50Hz 2 : 60Hz 2 camera.cameraimage-defaults TEXT 0 125 110 100 50 90 255 Camera image default settings. These are Backlight, Brightness, Contrast, Saturation, Sharpness, Hue, and Gamma. bt.bt-enable BOOLEAN String format: <"backlight"> <"brightness"> <"contrast"> <"saturation"> <"sharpness"> <"hue"> <"gamma"> backlight: <0..
bt.bt-callautojoin BOOLEAN 0 : Disable BT call auto join 1 : Enable BT call auto join 0 Enable/disable a Bluetooth call to auto join a USB based conference when there is no dialer app in use. bt.bt-autounpair-ondisconnect BOOLEAN 0 : Disable BT auto unpair on disconnect 1 : Enable BT auto unpair on disconnect 0 Enable/disable whether a BT device is automatically unpaired when it disconnects from the CS700. net.dhcp BOOLEAN 0 : Disable DHCP 1 : Enable DHCP 1 Enables or disables DHCP.
net.ntp1 TEXT IP address or URL or DNS name. 0.pool.ntp.org Configure first NTP (Network Time Protocol) server address. net.ntp2 TEXT IP address or URL or DNS name. 1.pool.ntp.org Configure second NTP (Network Time Protocol) server address. net.ntp3 TEXT IP address or URL or DNS name. 2.pool.ntp.org Configure third NTP (Network Time Protocol) server address. net.ntp4 TEXT IP address or URL or DNS name. net.dot1xenabled BOOLEAN 0 : Disable 802.1x authentication 1 : Enable 802.
voip.proxy TEXT IP address or name. Separate multiple addresses by a comma. Add ";lr" suffix for loose routing. voip.reg-useproxy INDEXED_ OPTION 0 : No proxy 1 : Outbound only 2 : Acc only 3 : All voip.user TEXT SIP username. voip.password TEXT SIP user password. voip.id TEXT SIP ID. voip.name TEXT VoIP Display Name. Yamaha CS-700 Integrators Reference Guide 0 The outbound SIP proxy server's IP address or name. If there are multiple SIP proxies, separate the addresses by a comma.
voip.reg-timeout NUMBER 1..604800 : Registration timeout in seconds 60 Registration Timeout is the optional timeout for SIP account registration, in seconds. voip.rereg-delay NUMBER 1..604800 : Auto reregistration retry interval in seconds 300 Configure auto reregistration retry interval in seconds. If SIP registration is unsuccessful, this property specified the time duration between retry attempts in seconds. voip.
voip.use-100rel BOOLEAN 0 : Disable reliable provisional responses 1 : Enable reliable provisional responses 0 voip.autoupdate-nat BOOLEAN 0 : Disable NAT 1 : Enable NAT 1 voip.dtmfmethod TEXT 0 : RTP -- RFC2833 1 : SIP INFO 2 : In-band 0 voip.dtmf-rtppayload-type TEXT 96..127 96 Yamaha CS-700 Integrators Reference Guide Implements reliable SIP provisional responses. SIP is a request-response type of protocol with two types of responses: provisional and final.
voip.mediaonhold-method BOOLEAN 0 : M line only -RFC3264 1 : M and C line -RFC2543 0 The Media on Hold method setting allows switching the Media on Hold behavior between the different RFC definitions. voip.
voip.set-qos BOOLEAN 0 : Disable QoS 1 : Enable QoS 0 voip.udp-tcpselection voip.local-port BOOLEAN 0 : UDP 1 : TCP 1024..65535 : Port number 0 voip.ip-addr TEXT ip-address : IP address voip.bound-addr TEXT voip.no-refer-sub BOOLEAN ip-address : IP address 0 : Disable suppressing subscription 1 : Enable suppressing subscription NUMBER Yamaha CS-700 Integrators Reference Guide 5060 0 Option to enable QoS (Quality of Service) tagging for SIP and media.
voip.min-size BOOLEAN 0 : Do not use compact format 1 : Use compact format. 0 voip.allow-strict BOOLEAN 0 : Enable strict routing 1 : Disable strict routing 0 Yamaha CS-700 Integrators Reference Guide Use compact SIP message format. The SIP protocol specifies that header field names can be in the full name form or in the abbreviated form.
voip.stun-srv TEXT stun-address : String. IP address, domain name, or host name, and optional port number. Separate multiple addresses by comma. voip.use-ice BOOLEAN 0 : Disable ICE 1 : Enable ICE 0 voip.
voip.ice-maxhosts NUMBER 0 : No maximum 1..10 : Maximum number of host candidates 5 voip.ice-no-rtcp BOOLEAN 0 voip.use-turn BOOLEAN 0 : Do not disable RTCP 1 : Keep RTCP disabled 0 : Disable TURN 1 : Enable TURN voip.turn-srv TEXT address : String. The format is either 'DOMAIN:PORT' or 'HOST:PORT'. voip.turn-user TEXT User name. voip.turn-passwd TEXT Password. voip.
voip.codec1 INDEXED_ OPTION 0 : None 1 : G.722 2 : G.711 u-law (PCMU) 3 : G.711 A-law (PCMA) 4 : G.726 5 : G.729 1 Highest prioritized codec. At least one codec different from “None” has to be selected in voip.codec1voip.codec5. voip.codec2 INDEXED_ OPTION 0 : None 1 : G.722 2 : G.711 u-law (PCMU) 3 : G.711 A-law (PCMA) 4 : G.726 5 : G.729 2 Second highest prioritized codec. At least one codec different from “None” has to be selected in voip.codec1-voip.codec5. voip.
voip.ptime NUMBER 10..60 : ptime interval in ms 20 The ptime (packetization interval) value for a codec determines the length of time in milliseconds represented by the media in an RTP packet which is used to transmit audio traffic. voip.mwi BOOLEAN 0 : Disable MWI signaling 1 : Enable MWI signaling 0 voip.vm-number TEXT VoIP voicemail number. voip.
7 voip.alwaysforwarding BOOLEAN 0 : Disable 1 : Enable voip.alwaysforwarding-num TEXT VoIP dialing number. voip.busyforwarding BOOLEAN 0 : Disable 1 : Enable voip.busyforwarding-num TEXT VoIP dialing number. voip.noanswerforwarding BOOLEAN 0 : Disable 1 : Enable voip.noanswerforwarding-num TEXT VoIP dialing number. voip.noanswerdelay NUMBER 2..30 : Seconds to wait before forwarding a call 0 0 0 10 Enable or disable forwarding all incoming VoIP calls to the specified number.
snmp-community Specifies the SNMP read-only community string used for queries from the server and transmitted traps. Read-only indicates the authorization level. The device does not support write operations initiated through SNMP. snmp-contact-name Specifies the contact name, typically the system administrator. This string is informational and can include an email address. It is not associated with traps. snmp-device-location Specifies the location of the device for informational purposes.
cs700 OBJECT IDENTIFIER ::= { yamahaAgentMIB 7386 } cs700Traps OBJECT IDENTIFIER ::= { cs700 1 } cs700TrapsObjects OBJECT IDENTIFIER ::= { cs700Traps 1 } --- CS-700 objects -serial OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "Serial number of type String." ::= {cs700 11} version OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "Base version of type String.
::= {cs700 16} btConnected OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "Bluetooth connection active (0,1) of type String." ::= {cs700 17} voipCallStatus OBJECT-TYPE SYNTAX DisplayString MAX-ACCESS read-only STATUS current DESCRIPTION "Current VoIP call lines 1-3 call state of type String.
Appendix A – Volume Mappings The table below identifies the volume mapping between the CS-700 device and the host operating systems. Windows 7 and 8 are shown in column W7. Windows 10 is column W10. Mac and Chrome are shown in column MAC.
Appendix B – Crestron Integration TCP/IP Integration with Crestron over TCP/IP is through IP interface. Crestron is required to maintain a continuous IP session with CS-700 in order to control its behavior properly. When integrating with Crestron, following these steps will provide a good user experience: 1- Crestron device must maintain a session with CS-700 at all times. On a lost session, Crestron device must repeatedly attempt the telnet/SSH connection till the connection is re-established.
The hold command automatically removes calls from conference, but if you just send the hold command for line 1, line 2 will remain in conference. It is best practice to send the join command to split the conference first. join 1 0 2 0 hold 1 hold 2 Resume calls and re-establish the conference Both lines need to be in active state before they can be joined. Note, leaving two lines in active state without joining them will produce undefined telephony behavior.
The USB line is for PC based calls and audio, where CS-700 is the speaker/microphone device. The user starts with USB line active, an incoming SIP call on line 1, and an incoming SIP call on line 2. hold usb answer 1 At the point, SIP line 1 is in active state, and the USB line is in hold state. hold 1 At the point, both SIP line 1, and USB line are in hold state. answer 2 At the point, both SIP line 1, and USB line are in hold state, and SIP line 2 is in active state.
The user starts with all lines on hold, and not in conference. resume 1 resume usb At this point, line 1 and USB are in active state, and line 2 is in held state. Note, leaving two lines in active state without holding either or both will produce undefined telephony behavior. join 1 1 2 0 usb 1 At this point, line 1 and USB are in conference, and line 2 is on hold outside the conference. The user now puts line 2 in conference. resume 2 At this point, line 2 and the conference are in active state.
