Yamaha CS-700
Integrators Reference Guide
Revision 5.2
3/24/2020

Yamaha Unified Communications
144 North Road, Suite 3250
Sudbury, MA 01776
978-610-4040

Table of Contents
1

Overview ......................................................................................................................................... 82

USB Description ............................................................................................................................... 8
2.1

VID and PID .............................................................................................................................. 9

2.2Interface Definitions for the USB HUB Component ................................................................... 9

2.3

Interface Definitions for the Audio Component ........................................................................ 9

2.3.1

Audio Report .................................................................................................................... 9

2.3.2

Speaker Volume Synchronization.................................................................................... 10

2.4Interface Definitions for the Camera Component ................................................................... 11

2.4.1

Video Configuration and Status ...................................................................................... 11

2.4.2

Video Stream.................................................................................................................. 123

IP Interface .................................................................................................................................... 13

4echo ....................................................................................................................................... 14
Library Interface ............................................................................................................................ 14
4.1

5

USB Library Reference ............................................................................................................ 15

CsDevComm_Mode enum...................................................................................................... 15
devAttach .............................................................................................................................. 15
devDetach .............................................................................................................................. 16
isConnected ........................................................................................................................... 16
coreCliCmd............................................................................................................................. 16
notifCtrl ................................................................................................................................. 17
updateFirmware .................................................................................................................... 17
downloadLogs ........................................................................................................................ 18
importConfig .......................................................................................................................... 18
exportConfig .......................................................................................................................... 19
API Command Reference ............................................................................................................... 19
5.1

Overview................................................................................................................................ 19

5.2

Categories .............................................................................................................................. 20

5.2.1
5.2.1.1

System ........................................................................................................................... 20
System Properties....................................................................................................... 20

product .................................................................................................................................. 20
base-sernum .......................................................................................................................... 21
voip-capable .......................................................................................................................... 21
base-ver ................................................................................................................................. 22
systemname........................................................................................................................... 23
md5-password ....................................................................................................................... 23

Yamaha CS-700 Integrators Reference Guide2

enable-btn-camera................................................................................................................. 24
enable-btn-audio ................................................................................................................... 24
enable-btn-volume................................................................................................................. 25
enable-btn-bluetooth ............................................................................................................. 26
enable-led-call ....................................................................................................................... 26
region .................................................................................................................................... 27
recent-call-enabled ................................................................................................................ 28
require-https .......................................................................................................................... 29
power-saving-mode ............................................................................................................... 29
power-saving-time ................................................................................................................. 30
auto-deploy ........................................................................................................................... 31
enable-deploy ........................................................................................................................ 31
provisioning-interval .............................................................................................................. 32
snmp-enable .......................................................................................................................... 33
snmp-community ................................................................................................................... 33
snmp-contact-name ............................................................................................................... 34
snmp-device-location ............................................................................................................. 35
dialer-connection-mode ......................................................................................................... 35
snmp-address......................................................................................................................... 36
verbose-log-enabled .............................................................................................................. 37
ui-mask .................................................................................................................................. 38
5.2.1.2 System Statuses .......................................................................................................... 39
usb-conn-status ..................................................................................................................... 39
upgrade-status ....................................................................................................................... 39
camera-upgrade-status .......................................................................................................... 40
power-saving-status ............................................................................................................... 40
usb-aud-rx-status ................................................................................................................... 41
usb-aud-tx-status ................................................................................................................... 42
5.2.1.3 System Commands ..................................................................................................... 42
regnotify ................................................................................................................................ 42
restart .................................................................................................................................... 43
set reset-setting ..................................................................................................................... 43
5.2.2
Audio.............................................................................................................................. 44
5.2.2.1

Audio Properties......................................................................................................... 44

eq .......................................................................................................................................... 44
high-pass-filter ....................................................................................................................... 44
analog-audio-in-mode ............................................................................................................ 45
analog-audio-in-gain .............................................................................................................. 46
wireless-omni-mic .................................................................................................................. 46
wireless-direct-mic ................................................................................................................. 47
wireless-lapel-mic .................................................................................................................. 48
speaker-volume ..................................................................................................................... 48
ring-tone ................................................................................................................................ 49

Yamaha CS-700 Integrators Reference Guide3

ringer-volume ........................................................................................................................ 50
5.2.2.2 Audio Statuses ............................................................................................................ 50
speaker-mute......................................................................................................................... 50
mute ...................................................................................................................................... 51
mic-conn-status ..................................................................................................................... 52
5.2.3
Camera........................................................................................................................... 52
5.2.3.1

Camera Properties ...................................................................................................... 52

camera-ptz-home................................................................................................................... 52
camera-flicker ........................................................................................................................ 53
camera-image-defaults .......................................................................................................... 54
5.2.3.2 Camera Statuses ......................................................................................................... 54
camera-status ........................................................................................................................ 54
camera-stream....................................................................................................................... 55
camera-door .......................................................................................................................... 56
camera-mute ......................................................................................................................... 56
camera-pan ............................................................................................................................ 57
camera-tilt ............................................................................................................................. 58
camera-zoom ......................................................................................................................... 58
camera-backlight.................................................................................................................... 59
camera-brightness ................................................................................................................. 60
camera-contrast ..................................................................................................................... 60
camera-saturation.................................................................................................................. 61
camera-sharpness .................................................................................................................. 62
camera-hue............................................................................................................................ 62
camera-gamma ...................................................................................................................... 63
5.2.3.3 Camera Commands .................................................................................................... 63
cam-save-as-default ............................................................................................................... 64
cam-apply-defaults ................................................................................................................ 64
cam-image-save-as-default .................................................................................................... 64
cam-image-apply-defaults ...................................................................................................... 65
cam-zoom-in .......................................................................................................................... 65
cam-zoom-out........................................................................................................................ 65
cam-pan-left .......................................................................................................................... 66
cam-pan-right ........................................................................................................................ 66
cam-tilt-up ............................................................................................................................. 67
cam-tilt-down ........................................................................................................................ 67
5.2.4
Bluetooth ....................................................................................................................... 67
5.2.4.1

Bluetooth Properties .................................................................................................. 67

bt-enable ............................................................................................................................... 67
bt-mac ................................................................................................................................... 68
bt-name ................................................................................................................................. 69
bt-pin ..................................................................................................................................... 69

Yamaha CS-700 Integrators Reference Guide4

bt-pair-timeout ...................................................................................................................... 70
bt-call-autojoin....................................................................................................................... 71
bt-auto-unpair-on-disconnect ................................................................................................ 71
5.2.4.2 Bluetooth Statuses ..................................................................................................... 72
bt-status ................................................................................................................................ 72
bt-paired-list .......................................................................................................................... 73
bt-connected ......................................................................................................................... 73
5.2.4.3 Bluetooth Commands ................................................................................................. 74
bt-pair .................................................................................................................................... 74
bt-unpair ................................................................................................................................ 74
bt-disconnect ......................................................................................................................... 75
nfc-enable .............................................................................................................................. 75
5.2.5
Call ................................................................................................................................. 76
5.2.5.1

Call Statuses ............................................................................................................... 76

status ..................................................................................................................................... 76
status-all ................................................................................................................................ 77
call-info .................................................................................................................................. 78
number .................................................................................................................................. 78
caller ...................................................................................................................................... 79
start-time ............................................................................................................................... 79
codec ..................................................................................................................................... 80
call-quality ............................................................................................................................. 81
5.2.5.2 Call Commands ........................................................................................................... 82
dial ......................................................................................................................................... 82
answer ................................................................................................................................... 82
hangup................................................................................................................................... 82
hold ....................................................................................................................................... 83
resume................................................................................................................................... 83
swap ...................................................................................................................................... 84
join ........................................................................................................................................ 84transfer .................................................................................................................................. 85
play ring-tone......................................................................................................................... 85
5.2.6
Network ......................................................................................................................... 86
5.2.6.1

Network Properties .................................................................................................... 86

mac ........................................................................................................................................ 86
dhcp ....................................................................................................................................... 86
ip ........................................................................................................................................... 87
subnet.................................................................................................................................... 88
gateway ................................................................................................................................. 88
dns1 ....................................................................................................................................... 89
dns2 ....................................................................................................................................... 90
vlan ........................................................................................................................................ 90

Yamaha CS-700 Integrators Reference Guide

5

vlan-id .................................................................................................................................... 91
ntp1 ....................................................................................................................................... 91
ntp2 ....................................................................................................................................... 92
ntp3 ....................................................................................................................................... 93
ntp4 ....................................................................................................................................... 93
dot1x-enabled ........................................................................................................................ 94
dot1x-identity ........................................................................................................................ 95
dot1x-password ..................................................................................................................... 95
5.2.6.2 Network Commands ................................................................................................... 96
set net-commit....................................................................................................................... 96
5.2.7
VoIP................................................................................................................................ 96
5.2.7.1

VoIP Properties........................................................................................................... 96

registrar ................................................................................................................................. 96
registrar-backup ..................................................................................................................... 97
realm ..................................................................................................................................... 98
proxy...................................................................................................................................... 99
reg-use-proxy ......................................................................................................................... 99
user...................................................................................................................................... 100
password ............................................................................................................................. 101
id ......................................................................................................................................... 101
name.................................................................................................................................... 102
reg-timeout.......................................................................................................................... 102
rereg-delay........................................................................................................................... 103
use-timer ............................................................................................................................. 104
timer-se ............................................................................................................................... 105
timer-min-se ........................................................................................................................ 105
use-100rel ............................................................................................................................ 106
auto-update-nat ................................................................................................................... 107
dtmf-method ....................................................................................................................... 107
media-onhold-method ......................................................................................................... 109
use-srtp................................................................................................................................ 109
rtp-port ................................................................................................................................ 110
set-qos ................................................................................................................................. 111
udp-tcp-selection ................................................................................................................. 111
local-port ............................................................................................................................. 112
ip-addr ................................................................................................................................. 113
bound-addr .......................................................................................................................... 113
no-refer-sub ......................................................................................................................... 114
min-size ............................................................................................................................... 115
allow-strict ........................................................................................................................... 116
stun-srv ................................................................................................................................ 116
use-ice ................................................................................................................................. 117
ice-regular............................................................................................................................ 118

Yamaha CS-700 Integrators Reference Guide6

ice-max-hosts ....................................................................................................................... 119
ice-no-rtcp ........................................................................................................................... 119
use-turn ............................................................................................................................... 120
turn-srv ................................................................................................................................ 121
turn-user .............................................................................................................................. 121
turn-passwd ......................................................................................................................... 122
turn-tcp ................................................................................................................................ 123
codec1 ................................................................................................................................. 123
codec2 ................................................................................................................................. 124
codec3 ................................................................................................................................. 125
codec4 ................................................................................................................................. 125
codec5 ................................................................................................................................. 126
ptime ................................................................................................................................... 127
mwi...................................................................................................................................... 128
vm-number .......................................................................................................................... 128
vm-count ............................................................................................................................. 129
do-not-disturb ...................................................................................................................... 130
auto-answer ......................................................................................................................... 130
duration ............................................................................................................................... 131
dial-plan ............................................................................................................................... 132
always-forwarding................................................................................................................ 132
always-forwarding-num ....................................................................................................... 133
busy-forwarding ................................................................................................................... 133
busy-forwarding-num........................................................................................................... 134
noanswer-forwarding........................................................................................................... 135
noanswer-forwarding-num .................................................................................................. 135
noanswer-delay ................................................................................................................... 136
5.2.7.2 VoIP Statuses ............................................................................................................ 137
registration .......................................................................................................................... 137
5.2.7.3 VoIP Commands ....................................................................................................... 137

67

set dtmf ............................................................................................................................... 137
set voip-commit ................................................................................................................... 138
Provisioning ................................................................................................................................. 138
6.1

Provisioning Files.................................................................................................................. 139

6.2

Provisioning File Parameters ................................................................................................ 140

SNMP .......................................................................................................................................... 157

Appendix A – Volume Mappings .......................................................................................................... 161
Appendix B – Crestron Integration TCP/IP............................................................................................ 162

Yamaha CS-700 Integrators Reference Guide

7

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 andexternal clients can use to manage and monitor the CS-700.
Clients can communicate with the device through these interface mechanisms:• USB
o USB HID (Human Interface Device)o USB Bulk
• IP
o Telnet
o SSH
o Provisioning per DHCP option 66 or 150 over HTTP, TFTP or FTP
o SNMPFor the USB interface we provide a C library to enable a host application to easily integrate with the CS-700.
The guide is organized as follows:
•
•
•
•
•
•

2

USB Description – Details the USB interfaces to the host, including the hub, audio and camera
components.
IP Interface – Describes the IP interface that can be used to create applications to manage and control thedevice over IP.
Library Interface – Describes the C library interface that can be used to create applications to manage andcontrol the device over USB.
API Command Reference – Provide details of the API commands and notifications that can becommunicated between the host and device via the library, and the IP interface.
Provisioning – Describes how to provision the device via an IP connection using DHCP options 66 and 150.
SNMP – Describes SNMP support and the corresponding MIB for querying device status and for receiving
traps.

USB Description

When the CS-700 USB interface is connected to a host PC, four components of the CS-700 will enumerate with the
host:
•
•
•

USB HUB - provides both 2.0 and 3.0 USB connectivity
USB Audio - speaker and microphone, USB 2.0
USB Camera - supports USB 3.0 and 2.0

The host processor connects directly to the HUB chip. The HUB chip then connects to the other USB components inthe system as shown in the diagram below:
Host   HUB   Audio  Camera
The section below lists the CS-700 USB VIDs and PIDs, and the sections that follow describe each of the device's
USB interfaces.

Yamaha CS-700 Integrators Reference Guide8

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
CameraVID
0x04990x04990x04990x0499PID
0x40310x40330x40300x4032

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.0 Certified Hub and a USB 2.0 Certified Hub. Once the HUB
chip enumerates with the Host Processor, it will initiate the enumeration of the other Cannonball components.
The Hub will enumerate as follows:••

Universal Serial Bus Controller, USB 2.0 MTT Hub
Universal Serial Bus Controller, USB 3.0 Hub

2.3 Interface Definitions for the Audio Component
The USB Audio chip will enumerate the following interfaces:
•
•
•
•

•

2.3.1

Interface 0; Audio Control: ep0, input type (0x101), output type (0x405), bma-control (3)Interface 1; Audio Output: Streaming, ep1 (OUT), ISOC- async, 2 channel, 48 KHz, 16/24 bit, 192 bytes
Interface 2; Audio Input: Streaming, ep2 (IN), ISOC- sync, 2 channel, 48 KHz, 16/24 bit, 288 bytes
Interface 3; HID: ep4 (IN), ep5 (OUT), 6 Report IDs:o ID 1: Input, Consumer Page, Volume +/-, size 1, count 2
o ID 2: Input, Custom Call Control Settings Page, size 8, count 1
o ID 3: Output, Telephony Page, (Mute, Hook, Flash Answer), size 1, count 5
o ID 4: IN/OUT, Custom Communications Page, size 8, count 31 (IN); 8, count 1 (OUT)o ID 5: IN/OUT, Skype Reports, (Mute, Hook, Flash) IN; (Mute, Hook, Ring, Hold) OUT
o ID 6: OUT, Custom Audio Settings, (Room Properties), size 8, count 7 (OUT)
Interface 4; BULK: ep7 (IN), ep8 (OUT), 64 bytes (Upgrade)

Audio Report

Yamaha CS-700 Integrators Reference Guide

9Description
Mic Mute States
Mic Mute
Mic Unmute
Speaker Volume Gain
Speaker volume
Speaker Volume Control
Volume Up
Volume Down
Mic Mute States
Mute
UnmuteCall Control
Off Hook (answer)
On Hook (hang up)
Hold
ResumeSystem Control
Restart System
Description
Mic Mute States
Mute
UnmuteCall States
Ringing (incoming call)
In Progress
On Hold
Ended
Description

Endpoint/
Report ID

Report
Value

Notes

ep0 / 0x06
ep0 / 0x06

0x00
0x01

Control Transfer from Host
Control Transfer from Host

ep0 / 0x02

value

To CS-700 from Host

ep4 / 0x01

0x01

ep4 / 0x01

0x02

Host responds with Control Transfer
speaker gain value on ep0 (seeabove)
Host responds with Control Transfer
speaker gain value on ep0 (seeabove)

ep4 / 0x02
ep4 / 0x02

0x02
0x00

ep4 / 0x02
ep4 / 0x02
ep4 / 0x02
ep4 / 0x02

0x04
0x01
0x05
0x06

ep4 / 0x02

0x03

Not supported

Endpoint/
Report ID

Report
Value

Notes

ep5 / 0x04
ep5 / 0x04

0x08
0x09

Host Application to CS-700
Host Application to CS-700

ep5 / 0x04
ep5 / 0x04
ep5 / 0x04
ep5 / 0x04

0x05
0x04
0x07
0x06

Report ID

ReportValue-

Telephony Page
Skype
CS-700 Audio Parameters

2.3.2

0x03
0x05
0x06

CS-700 VoIP App to Host
CS-700 VoIP App to Host

Notes
(Currently unused in Cannonball)See skype specification for details
Room Property Parameters (4)#People, EQ, MicHP, Reverb(Currently unused in Cannonball)

Speaker Volume Synchronization

Yamaha CS-700 Integrators Reference Guide

10The speaker volume can be controlled from the device by using the volume up/down cap-touch buttons on thebase 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 morevolume up/down reports to the host to achieve the best match based on the mapping. Likewise, when the hostsends to the device a speaker volume that the user selected on the host, the device maps that setting to a value inthe 1 to 18 range. See diagram below.
DeviceVolume Button Press*Map Gain to Index*Map Gain to IndexOS

Adjust Volume
Send Gain

Adjust Volume
Send Gain

ApplicationAdjust Volume on App
Send Gain to OS* Appendix A indicates the speaker volume mappings.

2.4 Interface Definitions for the Camera Component
The USB Camera interface will conform to USB Device Class Definition for Video Devices, version 1.5.
The USB Camera chip will enumerate the following interfaces:
USB 2.0• Interface 0; BULK: ep1 (in/out), 512 bit packet size
USB 3.0• Interface 0; Video Control: Interrupt, ep2 (IN), 1024 bit packet size
• Interface 1; Video Streaming: BULK, ep3 (IN), 1024 bit packet size

2.4.1

Video Configuration and Status

The video controls for pan, tilt and zoom (PTZ) are implemented digitally in the camera.
The video controls for brightness, contrast, sharpness, saturation, balance, backlight compensation and gain are
implemented in the camera image processor.
The host will use GET_CUR and SET_CUR requests to set the desired parameter. When the camera is enumerated,
the VC_INPUT_TERMINAL descriptor and VC_PROCESSING_UNIT descriptor will set the appropriate flags for theparameters is supports. It will also define an endpoint for interrupt support to report local changes back to thehost.

Yamaha CS-700 Integrators Reference Guide

11Description
Video Control ID
Zoom
PanTilt
Roll
Exposure
PrivacyVideo Processing ID
Backlight
Brightness
Contrast
Saturation
Sharpness
Hue
Gamma
Flicker

2.4.2

ID
ep0/4
0x0B
0x0D
0x0F
0x04
0x11
ep0/2
0x01
0x02
0x03
0x07
0x08
0x06
0x09
0x05

Report Value

Notes

value
value
value
value
value

Range: 100->400
Range: +/- 30, Range: +/- 18
Not Used
Not Used
Not Used

value
value
value
value
value
value
value
value

Range: 0->5
Range: 0->250
Range: 60->140
Range: 50->150
Range: 0->255
Range: 0->180
Range: 1->255
1-50Hz, 2-60Hz

Video Stream

Skype video specifications* specify the following:•USB 2.0
o 640 x 480 , 30 fps, YUY2 color spaceo 640 x 360 , 30 fps, YUY2 color space•

USB 3.0
o 1920 x 1080 , 30 fps, YUY2/NV12 color spaceo 1280 x 720 , 30 fps, YUY2/NV12 color spaceo 640 x 360 , 30 fps, YUY2/NV12 color space

Note: The CS-700 video camera only supports uncompressed video formats, which limits the resolution in USB 2.0.
* Skype 2.0: Skype and Lync Video Capture Specification (Doc # H100693)
Skype 3.0: Skype for Business Video Capture Specification (Doc # H100693)

Yamaha CS-700 Integrators Reference Guide

12

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.
If the host can access the device via an IP connection, then the client can communicate via the IP-supported
commands.
To use an IP connection for the control, with the CS-700 being the server, the “Enable room control access” control
on the Admin Settings page has to be set to either “Room control enabled using Telnet” or to “Room control
enabled using SSH”. This IP connection does not have to be enabled to use the Yamaha Dialer Applicationthat runs on an Android based tablet.

To start the IP connection, provide the IP address, port number, user name and password in a telnet or a SSH clientto establish the connection. The login username is roomcontrol and the password is Yamaha-CS-700, both casesensitive. The port number is 23 for Telnet, and 22 for SSH. If it is required to see the API commands echoed backto the client, execute “set echo 1” command after each successful login.

Yamaha CS-700 Integrators Reference Guide

13

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:setCommand Definition:
Actionset

Definition

set echo <0|1>

Parameters:
Parameter
01

Description
Turn off screen echoTurn on screen echo

CLI Format Examples:
set echo 1

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

4

Library Interface

Integrators wanting to communicate programmatically with the CS-700 for device management or operational
control will find it most convenient to use the CS-700 Management Library. This is a C library that is available forWindows, and MacOS. It enables developers to access the device using higher-level functions without needing todirectly manage the low-level USB HID or bulk interface.
The library supports these features:
•
•
•
•
•
•

Connect to a device via USB
Transmit API commands
Receive API responses and asynchronous notifications
Upgrade firmware
Download logs
Import and export configuration files

The API commands are described in section 5, API Command Reference.
If the host is connected directly to the device via USB, then a client application can communicate via the USB
interface.
The Library interface is described below.

Yamaha CS-700 Integrators Reference Guide

14

4.1 USB Library ReferenceThis 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.

Syntax:typedef enum {CsDevComm_Mode_Auto = 0,
CsDevComm_Mode_Hid,
CsDevComm_Mode_Bulk,
CsDevComm_Mode_Num} CsDevComm_Mode;

devAttach
Description:

Establish USB communication with a device.

Syntax:EXPORT int __cdecl devAttach(int mode, void(*debug_callback)(char *msg),
void(*event_callback)(int type));Parameters:
Parameter
debug_callback
Msg

Description
The USB connection mode, Auto, HID or Bulk, chosen from enum CsDevComm_Mode.
Pointer to callback function to handle debug messages.
Pointer to debug message.

event_callback
Type

Type of event as listed in table below.

Mode

Pointer to callback function to handle events.

Return Values:
Value
-1
0
1
2

Description
General error
Success
No device connected
Failed authentication

Event Types:

Yamaha CS-700 Integrators Reference Guide

15

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. The commands are defined in in section 5, API
Command Reference.

Syntax:EXPORT int __cdecl coreCliCmd(char *cmd, char *rsp, int len);

Parameters:
Parameter
cmd

Description
CLI command string (see API Command Reference)

Yamaha CS-700 Integrators Reference Guide

16

rsp
len

Pointer to response string
Bytes available in response string

Return Values:
Value

Description
General failure
Success-10

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.

Syntax:EXPORT int __cdecl notifCtrl(int mode, void(*notif_callback_t)(char *msg));

Parameters:
Parameter

mode
notif_callback_t
msg

Description
Enable/disable notifications
Pointer to callback function to handle CLI notification
Callback function parameter: Notification message string (see API Command
Reference)

Return Values:
Value

Description
General failure
Success-1
0

updateFirmware
Description:

Update firmware on the CS-700 device. The host PC must have access to a proper firmware
bundle.

Syntax:EXPORT int __cdecl updateFirmware(char *bundle, void(*update_firmware_callback_t)(int
nPercent));

Parameters:
Parameter

bundleupdate_firmware_
callback_t

Description
Complete file path of upgrade bundle
Pointer to callback function to handle upgrade progress notifications

Yamaha CS-700 Integrators Reference Guide

17

nPercentCallback 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.

Syntax:EXPORT int __cdecl downloadLogs(char *filepath, void(*download_logs_callback_t)(int
nPercent, char *logname));Parameters:
Parameter

filepath
download_logs_
callback_t
nPercent
lognameDescription
Directory on host to which the log file will be saved
Pointer to callback function to handle download progress notifications
Callback function parameter: Percent completion. A value of -1 indicates a download
error.
Returned name of downloaded log file

Return Values:
Value
-1
0

Description
General failure
Success

importConfig
Description:

Import a configuration XML file to the CS-700 device. The host PC must have access to aproper configuration file. The output of this is the zipped config file after completion.

Syntax:EXPORT int __cdecl importConfig(char *configFile, void(*import_config_callback_t)(int
nPercent, char *filepath));Parameters:
Parameter

configFile

Description
Complete file path of config file

Yamaha CS-700 Integrators Reference Guide18

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 importerror.
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.

Syntax:EXPORT int __cdecl exportConfig(char *filepath,void(*export_config_callback_t)(int nPercent, char *filepath));Parameters:
Parameter

filepath
export_config_
callback_t
nPercent
filepath

Description
Directory on host to which the config file will be saved
Pointer to callback function to handle export progress notifications
Callback function parameter: Percent completion. A value of -1 indicates anexport error.
Callback function parameter: Returned name of downloaded config file.

Return Values:
Value
-1
0

5

Description
General failure
Success

API Command ReferenceThis section describes the API commands and notifications that can be transmitted between a device and hostusing the IP interface and the library interface defined in section 3 and section 4 above.

5.1 Overview

Yamaha CS-700 Integrators Reference Guide

19

The API is organized by functional Category, such as Audio and Camera, and within each category are listed theproperties, status items and commands that are available for that category. Notifications are identified with theircorresponding property or status item.
The table below describes the command syntax.
<parameter><"call-status"><0|1|2><connected|disconnected><0..10><"paired"> [<"mac"> <"name">][<"mac"> <"name">]+Items in angle brackets are parameters
A quoted item represents the name of a parameter further describedin the Parameters section.
A list of possible values are separated by vertical bars.
An unquoted parameter is a literal value.
A range of values is separated by an ellipsis.
Square brackets designate optional parameters.
A list of repeating values is designated by a plus sign.

For properties, the description lists the actions that can be performed on the property, including:get – property can be read; this is true of all properties
set – property can be set
notify – when the property changes, a notification is sent to registered clients
The Command Definition and Parameters tables describe each supported action and associated parameters andvalues.

5.2

Categories

The API is organized by these Categories:
•
•
•
•
•
•
•
•

System (sys)
Audio
CameraBluetooth (bt)
Bluetooth Low Energy (ble)CallNetwork (net)
VoIP

The sections below describe the interfaces supported in each category.
Changes to properties in the Network group must be applied by the net-commit command. See Appendix B –Crestron Integration TCP/IP for re-registration sequence with the SIP server.
Changes to properties in the VoIP group must be applied by the voip-commit command. See Appendix B –Crestron Integration TCP/IP for re-registration sequence with the SIP server.

5.2.1

System

5.2.1.1

System Properties

product

Yamaha CS-700 Integrators Reference Guide

20

Description:

Product name. Read-only set at manufacturing.

Property Actions:getCommand Definition:
Actionget
response

Definition

get productval product <"name">

Parameters:
Parameter

Description
String. Product name.
Valid values are CS-700 and CS-700-SP

name

CLI Format Examples:
get productval 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.

Property Actions:getCommand Definition:
Actionget
response

Definition

get base-sernum
val base-sernum <"number">Parameters:
Parameter

Description

numberString. Device serial number.

CLI Format Examples:
get base-sernum
val base-sernum CSS701000062

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

voip-capable

Yamaha CS-700 Integrators Reference Guide

21

Description:

Is VoIP supported on the device. This capability is set at the factory and cannot be changed.

Property Actions:getCommand Definition:
Actionget
response

Definition

get voip-capableval voip-capable <0|1>

Parameters:
Parameter

Description
Device does not support VoIP
Device does support VoIP

01

CLI Format Examples:get voip-capableval voip-capable 0

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

base-verDescription:

Query product version.

Property Actions:getCommand Definition:
Actionget
response

Definition

get base-ver
val base-ver <"version">

Parameters:
Parameter

Description

versionString. Firmware bundle version.

CLI Format Examples:
get base-ver
val base-ver 1.1.0.212

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

Yamaha CS-700 Integrators Reference Guide

22

systemname
Description:

Specifies the system name.

Property Actions:set, get, notify

Default Value:

Product name concatenated with the MAC address

Command Definition:
Actionget
response
set
notifyDefinition

get systemname
val systemname <"system-name">set systemname <"system-name">
notify sys.systemname <"system-name">

Parameters:
Parameter

systemname

Description
System name string

CLI Format Examples:
get systemname
val systemname CS-700 AC:44:F2:11:22:33
set systemname CS-700-MAINCONF
notify sys.systemname CS-700-MAINCONF

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

md5-password
Description:

Administrator password for the device, stored as MD5 sum.

Property Actions:set

Default Value:5735c3a7aa6ffcfe6ab123835584db75 (7386 as MD5 sum)

Command Definition:
Actionset
notifyDefinition

set md5-password <"password">
notify sys.md5-password <"password">

Parameters:
Parameter

password

Description
Password string as MD5 sum (32 hexadecimal numbers)

Yamaha CS-700 Integrators Reference Guide

23

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:
Actionget
response
set
notifyDefinition

get enable-btn-camera
val enable-btn-camera <0|1>
set enable-btn-camera <0|1>
notify sys.enable-btn-camera <0|1>

Parameters:
Parameter

Description
Disable button
Enable button

01

CLI Format Examples:
get enable-btn-camera
val enable-btn-camera 1
set enable-btn-camera 1
notify sys.enable-btn-camera 1

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

enable-btn-audio
Description:

Enable/disable the microphone mute button on the main unit.

Property Actions:set, get, notify

Default Value:

1

Command Definition:

Yamaha CS-700 Integrators Reference Guide

24

Actionget
response
set
notifyDefinition

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

01

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.

Property Actions:set, get, notify

Default Value:

1

Command Definition:
Actionget
response
set
notifyDefinition

get enable-btn-volume
val enable-btn-volume <0|1>
set enable-btn-volume <0|1>
notify sys.enable-btn-volume <0|1>

Parameters:
Parameter
01

Description
Disable button
Enable button

CLI Format Examples:
get enable-btn-volume
val enable-btn-volume 1
set enable-btn-volume 1

Yamaha CS-700 Integrators Reference Guide

25

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:
Actionget
response
set
notifyDefinition

get enable-btn-bluetooth
val enable-btn-bluetooth <0|1>
set enable-btn-bluetooth <0|1>
notify sys.enable-btn-bluetooth <0|1>

Parameters:
Parameter

Description
Disable button
Enable button

01

CLI Format Examples:
get enable-btn-bluetooth
val enable-btn-bluetooth 1
set enable-btn-bluetooth 1
notify sys.enable-btn-bluetooth 1

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

enable-led-callDescription:

Enable/disable the call state LED on the main unit.

Property Actions:set, get, notify

Default Value:

1

Command Definition:
ActiongetDefinition

get enable-led-callYamaha CS-700 Integrators Reference Guide26

responseset
notifyval 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

01

CLI Format Examples:
get enable-led-callval 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

regionDescription:

Region in which device is operating, setting by index.

Property Actions:set, get, notify

Default Value:

23

Command Definition:
Actionget
response
set
notifyDefinition

get region
val region <1..24>
set region <1..24>
notify sys.region <1..24>

Parameters:
Parameter
1
2
3
4
5
6
7
8
9

Description
Argentina
Australia
BelgiumBrazilCanadaChile
China
Costa Rica
FranceYamaha CS-700 Integrators Reference Guide

27

10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

Germany
Hong Kong
India
IsraelItaly
Japan
Malaysia
MexicoNew ZealandSingapore
South Africa
TaiwanUnited 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.

Property Actions:set, get, notify

Default Value:

1

Command Definition:
Actionget
response
set
notifyDefinition

get recent-call-enabled
val recent-call-enabled <0|1>
set recent-call-enabled <0|1>
notify sys.recent-call-enabled <0|1>

Parameters:
Parameter
01

Description
Disable recent call list
Enable recent call list

CLI Format Examples:

Yamaha CS-700 Integrators Reference Guide28

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:
Actionget
response
set
notifyDefinition

get require-httpsval require-https <0|1>
set require-https <0|1>
notify sys.require-https <0|1>

Parameters:
Parameter

Description
Do not require HTTPS
Require HTTPS01

CLI Format Examples:get require-httpsval require-https 0
set require-https 0
notify sys.require-https 0

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

power-saving-mode
Description:

Configure power saving mode setting.

Property Actions:set, get, notify

Default Value:

1

Yamaha CS-700 Integrators Reference Guide

29

Command Definition:
Actionget
response
set
notifyDefinition

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

01

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.0

power-saving-time
Description:

Configure power saving time in minutes.

Property Actions:set, get, notify

Default Value:

20

Command Definition:
Actionget
response
set
notifyDefinition

get power-saving-time
val power-saving-time <0..480>
set power-saving-time <0..480>
notify sys.power-saving-time <0..480>

Parameters:
Parameter
timeout

Description
Power save timeout in minutes

CLI Format Examples:

Yamaha CS-700 Integrators Reference Guide30

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:
Actionget
response
set
notifyDefinition

get auto-deploy
val auto-deploy <0|1>
set auto-deploy <0|1>
notify sys.auto-deploy <0|1>

Parameters:
Parameter
01

Description
Disable auto-discovery of provisioning server
Enable auto-discovery of provisioning server

CLI Format Examples:
get auto-deploy
val auto-deploy 1
set auto-deploy 1
notify sys.auto-deploy 1

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

enable-deploy
Description:

Enable provisioning server.

Property Actions:set, get, notify

Yamaha CS-700 Integrators Reference Guide

31

Default Value:

1

Command Definition:
Actionget
response
set
notifyDefinition

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.0

provisioning-interval
Description:

Specify the provisioning interval for the device, in minutes.

Property Actions:set, get, notify

Default Value:

1440 (1 day)Command Definition:
Actionget
response
set
notifyDefinition

get provisioning-interval
val provisioning-interval <1..44640>
set provisioning-interval <1..44640>
notify sys.provisioning-interval <1..44640>

Parameters:
Parameter

1..44640

Description
Provisioning interval in minutes

CLI Format Examples:

Yamaha CS-700 Integrators Reference Guide

32

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:
Actionget
response
set
notifyDefinition

get snmp-enable
val snmp-enable <0|1>
set snmp-enable <0|1>
notify sys.snmp-enable <0|1>

Parameters:
Parameter
01

Description
Disable SNMP
Enable SNMP

CLI Format Examples:
get snmp-enable
val snmp-enable 1
set snmp-enable 1
notify sys.snmp-enable 1

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

snmp-community
Description:

Specifies the SNMP read-only community string used for queries from the server andtransmitted traps. Read-only indicates the authorization level. The device does not support
write operations initiated through SNMP.

Property Actions:set, get, notify

Yamaha CS-700 Integrators Reference Guide

33

Default Value:

publicCommand Definition:
Actionget
response
set
notifyDefinition

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.0

snmp-contact-name
Description:

Specifies the contact name, typically the system administrator. This string is informationaland can include an email address. It is not associated with traps.

Property Actions:set, get, notify

Command Definition:
Actionget
response
set
notifyDefinition

get snmp-contact-nameval snmp-contact-name <"contact">
set snmp-contact-name <"contact">
notify sys.snmp-contact-name <"contact">

Parameters:
Parameter
contact

Description
String. Contact name.

CLI Format Examples:
get snmp-contact-nameval snmp-contact-name "Jessica Taylor <jtaylor@abc.com>"

Yamaha CS-700 Integrators Reference Guide

34

set snmp-contact-name Jessica Taylor <jtaylor@abc.com>
notify sys.snmp-contact-name Jessica Taylor <jtaylor@abc.com>

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:
Actionget
response
set
notifyDefinition

get snmp-device-location
val snmp-device-location <"location">
set snmp-device-location <"location">
notify sys.snmp-device-location <"location">

Parameters:
Parameter

location

Description
String. Device location.

CLI Format Examples:
get snmp-device-location
val snmp-device-location "Bldg 12 Conf Room CB"
set snmp-device-location Bldg 12 Conf Room CB
notify sys.snmp-device-location Bldg 12 Conf Room CB

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

dialer-connection-mode
Description:
Property Actions:

Specifies the type of connection the tablet or dialer makes with the base.
set, get, notify

Default Value:

disconnected

Command Definition:
Actionget
response
set

Definition

get dialer-connection-mode
val dialer-connection-mode <ip|rc|disconnected>
set dialer-connection-mode <rc|disconnected>

Yamaha CS-700 Integrators Reference Guide

35

notify

notify sys.dialer-connection-mode <ip|rc|disconnected>

Parameters:
Parameterip
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.
ActionCurrent state
Current state ip
Current state rc
disconnected
set dialer-connection-mode
No state change
IP dialer
New state is
disconnecteddisconnection
disconnected
and new state is
disconnected
set dialer-connection-mode
New state is rc
IP dialer
No state changerc
disconnection;and new state isrc
Connect IP dialer
IP dialer becomesNo state change
No state change
connected and newstate is ip
Disconnect IP dialer
No state change
IP dialer
No state change
disconnection
and new state is
disconnected
CLI Format Examples:get dialer-connection-mode
val dialer-connection-mode ip
set dialer-connection-mode rc
notify sys.dialer-connection-mode rc

Supported Products: CS700-SP
Available in API Version: 1.1

snmp-address
Description:

Specifies SNMP server address to which traps will be sent.

Property Actions:set, get, notify

Command Definition:
ActionDefinition

Yamaha CS-700 Integrators Reference Guide

36

get snmp-address
val snmp-address <"address">
set snmp-address <"address">
notify sys.snmp-address <"address">get
response
set
notifyParameters:
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.0

verbose-log-enabled
Description:

Enable verbose logging.

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get verbose-log-enabled
val verbose-log-enabled <0|1>
set verbose-log-enabled <0|1>
notify sys.verbose-log-enabled <0|1>

Parameters:
Parameter
01

Description
Disable verbose logging
Enable verbose logging

CLI Format Examples:get verbose-log-enabled
val verbose-log-enabled 0
set verbose-log-enabled 0

Yamaha CS-700 Integrators Reference Guide37

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:
Actionget
response
set
notifyDefinition

get ui-mask
val ui-mask <”bit mask”>
set ui-mask <”bit mask”>
notify sys.ui-mask <”bit mask”>

Parameters:
Parameter

bit mask
0
1
2
4
8
16
32

Description
All menus are enabled in the dialer
For future use, value is ignored
For future use, value is ignored
Do not allow modifications of call forwarding
Do not allow modifications of call history
Do not allow modifications of contacts
Do not allow modifications of DND

CLI Format Examples:
get ui-mask
val ui-mask 0// this prevents the dialer from modifying DND
set ui-mask 32

notify sys.ui-mask 32// this prevents the dialer from modifying DND and call forwarding 32 + 4 = 36
set ui-mask 36

notify sys.ui-mask 36

Supported Products: CS700-SP
Available in API Version: 1.1

Yamaha CS-700 Integrators Reference Guide38

5.2.1.2

System Statuses

usb-conn-status
Description:

Query USB connection status.

Property Actions:get, notify

Command Definition:
Actionget
response
notifyDefinition

get usb-conn-status
val usb-conn-status <0|1>
notify sys.usb-conn-status <0|1>

Parameters:
Parameter
01

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.0

upgrade-status
Description:

Query upgrade status. .

Property Actions:get, notify

Command Definition:
Actionget
response
notifyDefinition

get upgrade-status
val upgrade-status <"status">
notify sys.upgrade-status <"status">

Parameters:
Parameter

Ready
Downloading

Description
Ready for upgrade
Downloading upgrade file

Yamaha CS-700 Integrators Reference Guide

39

FailedFlashing
WaitingCallEnd
RebootingUpgrade 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 Flashingnotify 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.

Property Actions:get, notify

Command Definition:
Actionget
response
notifyDefinition

get camera-upgrade-status
val camera-upgrade-status <"upgrade-status">
notify sys.camera-upgrade-status <"upgrade-status">

Parameters:
Parameter

Started
Downloading
RebootingCompleteFailedpmuterogress
Current

Description
Upgrade has started.
Downloading upgrade file.
Rebooting after upgrade.
Upgrade successful and complete.
Upgrade failed
Progress of update. This string will be followed by percent complete.
This is synonymous with complete. Revision of upgrade and current FW match.

CLI Format Examples:
get camera-upgrade-status
val camera-upgrade-status Downloading
notify sys.camera-upgrade-status Downloading

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

power-saving-status

Yamaha CS-700 Integrators Reference Guide

40

Description:

System standby status.

Property Actions:get, notify

Command Definition:
Actionget
response
notifyDefinition

get power-saving-status
val power-saving-status <0|1>
notify sys.power-saving-status <0|1>

Parameters:
Parameter
01

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.0

usb-aud-rx-status
Description:

Query state of USB RX audio stream (RX audio being received, stopped).

Property Actions:get, notify

Command Definition:
Actionget
response
notifyDefinition

get usb-aud-rx-status
val usb-aud-rx-status <0|1>
notify sys.usb-aud-rx-status <0|1>

Parameters:
Parameter
01

Description
USB audio RX stream is closed
USB audio RX stream is open

CLI Format Examples:
get usb-aud-rx-status
val usb-aud-rx-status 1
notify sys.usb-aud-rx-status

1

Yamaha CS-700 Integrators Reference Guide

41

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:
Actionget
response
notifyDefinition

get usb-aud-tx-status
val usb-aud-tx-status <0|1>
notify sys.usb-aud-tx-status <0|1>

Parameters:
Parameter
01

Description
USB audio TX stream is closed
USB audio TX stream is open

CLI Format Examples:
get usb-aud-tx-status
val usb-aud-rx-status 1
notify sys.usb-aud-tx-status 1

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

5.2.1.3

System Commands

regnotify
Description:

Register client for notifications.

Command Definition:
ActionexecuteParameters:

Definition

regnotify

None

CLI Format Examples:
regnotify

Supported Products: CS700-AV, CS700-SP
Yamaha CS-700 Integrators Reference Guide

42

Available in API Version: 1.0

restartDescription:

Restart system.

Command Definition:
ActionexecuteParameters:

Definition
restartNone

CLI Format Examples:restartSupported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

set reset-setting
Description:

Reset settings by category.

Command Definition:
ActionexecuteDefinition

set reset-setting <"category">

Parameters:
Parameter

all
voip
audio
network
camerabt
contacts
call-history

Description
Reset all properties
Reset VoIP properties
Reset audio properties
Reset network properties
Reset camera properties
Reset Bluetooth properties
Delete all VoIP contacts
Delete call history

CLI Format Examples:
set reset-setting all

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

Yamaha CS-700 Integrators Reference Guide43

5.2.2Audio

5.2.2.1

Audio Properties

eq
Description:

EQ setting used to adjust the speaker frequencies to your preference for the room and thetypes of calls.

Property Actions:set, get, notify

Default Value:

1

Command Definition:
Actionget
response
set
notifyDefinition

get eqval 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 eqval eq 1
set eq 1
notify audio.eq 1

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

high-pass-filter
Description:

High-Pass filter setting. High-Pass filters are provided to adjust to room and application
requirements. Use the High-Pass filter in rooms that have a high background noise in the
low frequencies (air conditioning, lighting fixtures, etc.). All filters are bi-quad filters,
reducing the signal by 6dB per octave.

Property Actions:set, get, notify

Default Value:0

Yamaha CS-700 Integrators Reference Guide

44

Command Definition:
Actionget
response
set
notifyDefinition

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 Hz140 Hz175 Hz225 Hz0
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.0

analog-audio-in-mode
Description:

For the TV audio in port, select the gain setting mode, either auto or manual.

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get analog-audio-in-mode
val analog-audio-in-mode <0|1>
set analog-audio-in-mode <0|1>
notify audio.analog-audio-in-mode <0|1>

Parameters:
Parameter
01

Description
Automatic gain setting
Manually specify gain setting

Yamaha CS-700 Integrators Reference Guide

45

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.5

Command Definition:
Actionget
response
set
notifyDefinition

get analog-audio-in-gain
val analog-audio-in-gain <-12..40>
set analog-audio-in-gain <-12..40>
notify audio.analog-audio-in-gain <-12..40>

Parameters:
Parameter-12, -11.5..40

Description
Manual gain settingThis value can be increased or decreased by 0.5dB

CLI Format Examples:
get analog-audio-in-gain
val analog-audio-in-gain 4.5
set analog-audio-in-gain 4.5
notify audio.analog-audio-in-gain 4.5

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

wireless-omni-mic
Description:

Enables additional audio processing of extension wireless omni-directional microphones.

Yamaha CS-700 Integrators Reference Guide

46

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

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 microphone01

CLI Format Examples:
get wireless-omni-mic
val wireless-omni-mic 0
set wireless-omni-mic 1
notify audio. wireless-omni-mic 1

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.3

wireless-direct-mic
Description:

Enables additional audio processing of extension wireless directional microphones.

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get wireless-direct-mic
val wireless-direct-mic <0|1>
set wireless-direct-mic <0|1>
notify audio.wireless-direct-mic <0|1>

Parameters:
Parameter
01

Description
Disable wireless directional microphone
Enable wireless directional microphone

Yamaha CS-700 Integrators Reference Guide

47

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.

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get wireless-lapel-mic
val wireless-lapel-mic <0|1>
set wireless-lapel-mic <0|1>
notify audio.wireless-lapel-mic <0|1>

Parameters:
Parameter
01

Description
Disable wireless lapel microphone
Enable wireless lapel microphone

CLI Format Examples:
get wireless-lapel-mic
val wireless-lapel-mic 0
set wireless-lapel-mic 1
notify audio. wireless-lapel-mic 1

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.3

speaker-volume
Description:
Property Actions:

Configure speaker volume for calls.
set, get, notify

Yamaha CS-700 Integrators Reference Guide48

Default Value:

13

Command Definition:
Actionget
response
set
notifyDefinition

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.

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get ring-tone
val ring-tone <0..5>
set ring-tone <0..5>
notify audio.ring-tone <0..5>

Parameters:
Parameter
0..5

Description
Ring-tone index

CLI Format Examples:get ring-tone
val ring-tone 0

Yamaha CS-700 Integrators Reference Guide49

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:
Actionget
response
set
notifyDefinition

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..18

CLI Format Examples:get ringer-volume
val ringer-volume 7
set ringer-volume 7
notify audio.ringer-volume 7

Supported Products: CS700-SP
Available in API Version: 1.1

5.2.2.2

Audio Statuses

speaker-muteDescription:

Mute speaker.

Property Actions:set, get, notify

Command Definition:

Yamaha CS-700 Integrators Reference Guide

50

Actionget
response
set
notifyDefinition

get speaker-muteval 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

01

CLI Format Examples:
get speaker-muteval 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.

Property Actions:set, get, notify

Command Definition:
Actionget
response
set
notifyDefinition

get mute
val mute <0|1>
set mute <0|1>
notify audio.mute <0|1>

Parameters:
Parameter
01

Description
Unmute mics
Mute mics

CLI Format Examples:
get mute
val mute 0
set mute 0

Yamaha CS-700 Integrators Reference Guide

51

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:
Actionget
response
notifyDefinition

get mic-conn-status
val mic-conn-status <”mic_number”> <connected|disconnected>
notify audio.mic-conn-status <connected|disconnected>

Parameters:
Parameterconnected
disconnected

Description
External mic is connected
External mic is disconnected

CLI Format Examples:
get mic-conn-status
val mic-conn-status 1 connected
notify audio.mic-conn-status connected

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

5.2.3

Camera5.2.3.1

Camera Properties

camera-ptz-home
Description:

Default PTZ settings for home position. When the device detects that the upstream USB
connection has been established, either at startup or after a USB disconnection, it willrevert to the default PTZ settings. Calling set on this property will move the camera to the
newly set PTZ position. See cam-save-as-defaults to save current PTZ to home setting.

Property Actions:set, get, notify

Default Value:

001

Command Definition:
ActiongetDefinition

get camera-ptz-home

Yamaha CS-700 Integrators Reference Guide

52

val camera-ptz-home <"pan"> <"tilt"> <"zoom">
set camera-ptz-home <"pan"> <"tilt"> <"zoom">
notify camera.camera-ptz-home <"pan"> <"tilt"> <"zoom">

response
set
notifyParameters:
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-homeval camera-ptz-home 0 0 100
set camera-ptz-home 0 0 100
notify camera.camera-ptz-home 0 0 100

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

camera-flicker
Description:
Property Actions:

Camera's flicker setting.
set, get, notify

Default Value:

2

Command Definition:
Actionget
response
set
notifyDefinition

get camera-flicker
val camera-flicker <1|2>
set camera-flicker <1|2>
notify camera.camera-flicker <1|2>

Parameters:
Parameter
1
2

Description
50Hz
60Hz

CLI Format Examples:
get camera-flicker
val camera-flicker 2
set camera-flicker 2
notify camera.camera-flicker 2

Yamaha CS-700 Integrators Reference Guide

53

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.

Property Actions:set, get, notify

Default Values:

0 125 110 100 50 90 255

Command Definition:
Actionget
response
set
notifyDefinition

get camera-image-defaults
val camera-image-defaults <"backlight"> <"brightness"><"contrast"> <"saturation"> <"sharpness"> <"hue"> <"gamma">
set camera-image-defaults <"backlight"> <"brightness"><"contrast"> <"saturation"> <"sharpness"> <"hue"> <"gamma">
notify camera.camera-image-defaults <"backlight"> <"brightness"><"contrast"> <"saturation"> <"sharpness"> <"hue"> <"gamma">

Parameters:
Parameter
0..50..25060..140
50..150
0..2550..180
1..255

Description
Backlight setting
Brightness setting
Contrast setting
Saturation setting
Sharpness setting
Hue setting
Gamma setting

CLI Format Examples:
get camera-image-defaults
val camera-image-defaults 1 125 110 100 85 90 220
set camera-image-defaults 1 125 110 100 85 90 220
notify camera.camera-image-defaults 1 125 110 100 85 90 220

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.1

5.2.3.2

Camera Statuses

camera-status
Yamaha CS-700 Integrators Reference Guide

54

Description:

Query camera state.

Property Actions:get, notify

Command Definition:
Actionget
response
notifyDefinition

get camera-status
val camera-status<off|initializing|reconnecting|unconnected|power_save|resync|on>
notify camera.camera-status<off|initializing|reconnecting|unconnected|power_save|resync|on>

Parameters:
Parameter

off
initializing
upgradingreconnecting
unconnected
power_save
resyncon

Description
Camera is off
Camera subsystem is initializing
Camera module's firmware is being upgraded
Camera is coming online
Camera is not connected to USB
Camera is in power save mode
Camera is updating user parameters
Camera is powered on and available for streaming

CLI Format Examples:
get camera-status
val camera-status on
notify camera.camera-status on

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

camera-stream
Description:

Query state of camera stream (video being sent, stopped)

Property Actions:get, notify

Command Definition:
Actionget
response
notifyDefinition

get camera-stream
val camera-stream <open|closed>
notify camera.camera-stream <open|closed>

Parameters:
Parameter

Description

Yamaha CS-700 Integrators Reference Guide

55

open
closedUSB 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:
Actionget
response
notifyDefinition

get camera-door
val camera-door <open|closed>
notify camera.camera-door <open|closed>

Parameters:
Parameter
openclosedDescription
Camera privacy door is open
Camera privacy door is closed

CLI Format Examples:
get camera-door
val camera-door open
notify camera.camera-door open

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

camera-muteDescription:

Camera video "mute” or stop state.

Property Actions:set, get, notify

Command Definition:
ActiongetDefinition

get camera-mute

Yamaha CS-700 Integrators Reference Guide

56

val camera-mute <0|1>
set camera-mute <0|1>
notify camera.camera-mute <0|1>

response
set
notifyParameters:
Parameter

Description
Camera video is not muted
Camera video is muted

01

CLI Format Examples:
get camera-muteval 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.

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get camera-pan
val camera-pan <-30..30>
set camera-pan <-30..30>
notify camera.camera-pan <-30..30>

Parameters:
Parameter-30..30

Description
Pan setting

CLI Format Examples:
get camera-pan
val camera-pan 0
set camera-pan 0
notify camera.camera-pan 0

Yamaha CS-700 Integrators Reference Guide

57

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:
Actionget
response
set
notifyDefinition

get camera-tilt
val camera-tilt <-18..18>
set camera-tilt <-18..18>
notify camera.camera-tilt <-18..18>

Parameters:
Parameter-18..18

Description
Tilt setting

CLI Format Examples:
get camera-tilt
val camera-tilt 0
set camera-tilt 0
notify camera.camera-tilt 0

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

camera-zoom
Description:

Camera's digital zoom setting. When zoom is set to 100, the pan and tilt settings will beforced to zero.

Property Actions:set, get, notify

Default Value:

100

Command Definition:
Actionget
response
set

Definition

get camera-zoom
val camera-zoom <100..400>
set camera-zoom <100..400>

Yamaha CS-700 Integrators Reference Guide

58

notify camera.camera-zoom <100..400>

notifyParameters:
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.

Property Actions:set, get, notify

Default Value:0

Command Definition:
ActionGet
response
Set
NotifyDefinition

get camera-backlight
val camera-backlight <0..5>
set camera-backlight <0..5>
notify camera.camera-backlight <0..5>

Parameters:
Parameter
0
1..5

Description
Off
Camera Backlight level.

CLI Format Examples:
get camera-backlight
val camera-backlight 2
set camera-backlight 2
notify camera.camera-backlight 2

Supported Products: CS700-AV, CS700-SP

Yamaha CS-700 Integrators Reference Guide

59

Available in API Version: 1.1

camera-brightness
Description:

Camera Brightness level

Property Actions:set, get, notify

Default Value:

125

Command Definition:
Actionget
response
set
notifyDefinition

get camera-brightness
val camera-brightness <0..250>
set camera-brightness <0..250>
notify camera.camera-brightness <0..250>

Parameters:
Parameter
0..250Description
Camera Brightness level.

CLI Format Examples:
get camera-brightness
val camera-brightness 125
set camera-brightness 125
notify camera.camera-brightness 125

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.1

camera-contrast
Description:

Camera Contrast level

Property Actions:set, get, notify

Default Value:

110

Command Definition:
Actionget
response

Definition

get camera-contrast
val camera-contrast <60..140>

Yamaha CS-700 Integrators Reference Guide

60

set
notifyset 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.1

camera-saturation
Description:

Camera Saturation level

Property Actions:set, get, notify

Default Value:

100

Command Definition:
Actionget
response
set
notifyDefinition

get camera-saturation
val camera-saturation <50..150>
set camera-saturation <50..150>
notify camera.camera-saturation <50..150>

Parameters:
Parameter
50..150

Description
Camera Saturation level.

CLI Format Examples:
get camera-saturation
val camera-saturation 100
set camera-saturation 100
notify camera.camera-saturation 100

Supported Products: CS700-AV, CS700-SP

Yamaha CS-700 Integrators Reference Guide

61

Available in API Version: 1.1

camera-sharpness
Description:

Camera Sharpness level

Property Actions:set, get, notify

Default Value:

85

Command Definition:
Actionget
response
set
notifyDefinition

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.camera-sharpness 100

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.1

camera-hue
Description:

Camera Hue level

Property Actions:set, get, notify

Default Value:

90

Command Definition:
Actionget
response
set
notifyDefinition

get camera-hue
val camera-hue <0..180>
set camera-hue <0..180>
notify camera.camera-hue <0..180>

Yamaha CS-700 Integrators Reference Guide

62

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:
ActionGet
Response
Set
NotifyDefinition

get camera-gamma
val camera-gamma <1..255>
set camera-gamma <1..255>
notify camera.camera-gamma <1..255>

Parameters:
Parameter
1..255

Description
Camera Gamma level.

CLI Format Examples:
get camera-gamma
val camera-gamma 100
set camera-gamma 100
notify camera.camera-gamma 100

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.1

5.2.3.3

Camera Commands

Yamaha CS-700 Integrators Reference Guide63

cam-save-as-default
Description:

Save the camera's current PTZ settings as the default values.

Command Definition:
ActionexecuteParameters:

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. These settings are also automatically applied when
the device detects that the upstream USB connection has been established, either atstartup or after a USB disconnection.

Command Definition:
ActionexecuteParameters:

Definition

cam-apply-defaults

None

CLI Format Examples:
cam-apply-defaults

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

cam-image-save-as-default
Description:

Save the camera's current Backlight, Brightness, Contrast, Saturation, Sharpness, Hue, andGamma settings as the default values.

Command Definition:
ActionexecuteDefinition

cam-image-save-as-default

Yamaha CS-700 Integrators Reference Guide

64

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, andGamma settings. These settings are also automatically applied when the device detects thatthe upstream USB connection has been established, either at startup or after a USB
disconnection.

Command Definition:
ActionexecuteParameters:

Definition

cam-image-apply-defaults

None

CLI Format Examples:
cam-image-apply-defaults

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.1

cam-zoom-in
Description:

Zoom in the camera by one level.

Command Definition:
ActionExecuteNotifyParameters:

Definition

cam-zoom-in
notify camera.zoom <100..400>

None

CLI Format Examples:
cam-zoom-in
notify camera.zoom 200

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.1

cam-zoom-out

Yamaha CS-700 Integrators Reference Guide

65

Description:

Zoom out the camera by one level.

Command Definition:
ActionExecuteNotifyParameters:

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:
ActionExecuteNotifyParameters:

Definition

cam-pan-left
notify camera.pan <-30..30>

None

CLI Format Examples:
cam-pan-left
notify camera.pan 10

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.1

cam-pan-right
Description:

Pan the camera right by one level.

Command Definition:
ActionExecuteNotifyParameters:

Definition

cam-pan-rightnotify camera.pan <-30..30>

None

CLI Format Examples:
cam-pan-rightnotify camera.pan 8

Yamaha CS-700 Integrators Reference Guide66

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:
ActionExecuteNotifyParameters:

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.

Command Definition:
ActionExecuteNotifyParameters:

Definition

cam-tilt-down
notify camera.tilt <-18..18>

None

CLI Format Examples:
cam-tilt-down
notify camera.tilt 5

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.1

5.2.4

Bluetooth

5.2.4.1

Bluetooth Properties

bt-enable
Description:
Property Actions:

Enable or disable Bluetooth.
set, get, notify

Yamaha CS-700 Integrators Reference Guide

67

Default Value:

1

Command Definition:
Actionget
response
set
notifyDefinition

get bt-enable
val bt-enable <0|1>
set bt-enable <0|1>
notify bt.bt-enable <0|1>

Parameters:
Parameter
01

Description
DisableEnable

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-macDescription:

Get the Bluetooth device's MAC address advertised over the air. This is read-only and set in
manufacturing.

Property Actions:getCommand Definition:
Actionget
response

Definition

get bt-mac
val bt-mac <"mac">

Parameters:
Parametermac

Description
MAC address of connected device

CLI Format Examples:
get bt-mac
val bt-mac AC:14:22:01:23:45

Yamaha CS-700 Integrators Reference Guide68

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

bt-nameDescription:

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:
Actionget
response
set
notifyDefinition

get bt-nameval bt-name <"name">set bt-name <"name">
notify bt.bt-name <"name">

Parameters:
Parameter
nameDescription
String. Name of device.

CLI Format Examples:
get bt-nameval bt-name Yamaha CS-700:22:33
set bt-name CS700-MAINCONF
notify bt.bt-name CS700-MAINCONF

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

bt-pinDescription:

The Bluetooth basic-rate pin for pairing. Pins are 4 digits.

Property Actions:set, get, notify

Default Value:

0000

Command Definition:
Actionget
response
set

Definition

get bt-pin
val bt-pin <"pin">set bt-pin <"pin">

Yamaha CS-700 Integrators Reference Guide69

notify

notify bt.bt-pin <"pin">

Parameters:
Parameter

Description
4-digit stringpin

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.

Property Actions:set, get, notify

Default Value:

60

Command Definition:
Actionget
response
set
notifyDefinition

get bt-pair-timeout
val bt-pair-timeout <0|30|60|90|120>
set bt-pair-timeout <0|30|60|90|120>
notify bt.bt-pair-timeout <0|30|60|90|120>

Parameters:
Parameter

030,60,90,120

Description
No timeout
Pairing timeout in seconds

CLI Format Examples:
get bt-pair-timeout
val bt-pair-timeout 60
set bt-pair-timeout 60
notify bt.bt-pair-timeout 60

Supported Products: CS700-AV, CS700-SP

Yamaha CS-700 Integrators Reference Guide

70

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:
Actionget
response
set
notifyDefinition

get bt-call-autojoin
val bt-call-autojoin <0|1>
set bt-call-autojoin <0|1>
notify bt.bt-call-autojoin <0|1>

Parameters:
Parameter

Description
Bluetooth call auto-join to USB disabled
Bluetooth call auto-join to USB enabled

01

CLI Format Examples:
get bt-call-autojoin
val bt-call-autojoin 0
set bt-call-autojoin 0
notify bt.bt-call-autojoin 0

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.3

bt-auto-unpair-on-disconnect
Description:

If enabled, when the Bluetooth device disconnects, it will automatically be unpaired fromthe CS-700. The Bluetooth device will need to be re-paired to the CS-700 to use it with the
CS-700.

Property Actions:set, get, notify

Default Value:0

Command Definition:
ActiongetDefinition

get bt-auto-unpair-on-disconnect

Yamaha CS-700 Integrators Reference Guide71

responseset
notifyval 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
01

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.4

5.2.4.2

Bluetooth Statuses

bt-status
Description:

Get the Bluetooth device status.

Property Actions:get, notify

Command Definition:
Actionget
response
notifyDefinition

get bt-status
val bt-status<Off|Initializing|Updating|Pairing|Enabled|Connecting|Connected>
notify bt.bt-status<Off|Initializing|Updating|Pairing|Enabled|Connecting|Connected>

Parameters:
Parameter

Off
Initializing
Updating
Pairing
EnabledConnecting
Connected

Description
Bluetooth is off
Bluetooth subsystem is initializing
Bluetooth processor firmware is being upgraded
Bluetooth is in pairing mode
Bluetooth is enabled and on
Bluetooth is on and connecting
A device is connected

CLI Format Examples:

Yamaha CS-700 Integrators Reference Guide72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 andname pairs.

Property Actions:getCommand Definition:
Actionget
response

Definition

get bt-paired-list
val bt-paired-list <"mac"> <"name"> [<"mac"> <"name">]+Parameters:
ParameterMac
name

Description
MAC address of paired device.
String. Name of paired device.

CLI Format Examples:
get bt-paired-list
val bt-paired-list D4:B3:77:EF:31:94 ADR6301 D4:B3:77:EF:31:95 ADR6302

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

bt-connected
Description:

Get Bluetooth basic-rate device connected status. If a device is connected, returns its MAC
address, name, and profiles.

Property Actions:get, notify

Command Definition:
Actionget
response
notifyDefinition

get bt-connectedval bt-connected [<"mac"> <"name">]notify bt.bt-connected [<"mac"> <"name">]Parameters:

Yamaha CS-700 Integrators Reference Guide73

Parameter
mac
name

Description
MAC address of connected device.
String. Name of connected device.

CLI Format Examples:
get bt-connectedval 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.

Command Definition:
ActionexecuteDefinition

bt-pair <0|1>

Parameters:
Parameter
01

Description
Cancel pairing
Initiate pairing

CLI Format Examples:
bt-pair 1

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

bt-unpair
Description:

Remove all Bluetooth devices in the paired devices list. If a device is connected, it will be
disconnected.

Command Definition:
ActionExecuteDefinition

bt-unpair <all>

Parameters:
Parameter

Description

Yamaha CS-700 Integrators Reference Guide

74

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:
ActionExecuteParameters:

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.

Property Actions:set, get, notify

Default Value:

1

Command Definition:
Actionget
response
set
notifyDefinition

get nfc-enable
val nfc-enable <0|1>
set nfc-enable <0|1>
notify bt.nfc-enable <0|1>

Parameters:
Parameter
01

Description
Disable NFC and NFC LED
Enable NFC and NFC LED

CLI Format Examples:
get nfc-enable

Yamaha CS-700 Integrators Reference Guide

75

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

Call

5.2.5.1

Call Statuses

statusDescription:

Query a call status.

Property Actions:get, notify

Command Definition:
ActionGet
Response
NotifyDefinition

get status <1..3|usb|bt>
val status <1..3|usb|bt> <"call-status">
notify call.status <1..3|usb|bt> <"call-status">

Parameters:
Parameter

1
2
3
usb
bt
call-status
VoIP Calls
idle
incoming
calling
failedconnected
onholdconnected-inconf
disconnected
updatemissedUSB Calls

Description
VoIP line 1
VoIP line 2
VoIP line 3 (used for transfer)
USB line
Bluetooth line
String as shown below for each call type.
Initialization state.
Receiving incoming VoIP call.
Initiating outgoing VoIP call.
Outgoing call attempt failed; it is followed by “disconnected” when the attempt is
disconnected.
Call is connected.
Call is on hold.
Call is in a conference.
Not in a call or phone is not registered.
The call is transferred by the far end (with some call managers the call state will remain“connected” after the transfer).
Incoming VoIP call missed due to Do-Not-Disturb.

Yamaha CS-700 Integrators Reference Guide76

activeidle
incoming
inactive
connected
onholdconnected-inconf
BT Calls
activeidle
incoming
inactive
connected
onholdconnected-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.

CLI Format Examples:
get status 1
val status 1 connected
notify call.status 1 connected

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0, VoIP Available in API Version: 1.1

status-all
Description:

Query all call status. See "call-status" property for description of status types.

Property Actions:getCommand Definition:
Actionget
response

Definition

get status-all
val status-all line1:<”status1”> line2:<”status2”>
line3:<”status3”> bt:<”statusbt”> usb:<”statususb”>

Parameters:
Parameter

status1
status2
status3
statusbt
statususb

Description
VoIP line 1 call status
VoIP line 2 call status
VoIP line 3 call status
Bluetooth call status
USB call status

CLI Format Examples:

Yamaha CS-700 Integrators Reference Guide77

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:getCommand Definition:
Actionget
response

Definition

get call-info <1..3, bt, usb>
val call-info <1..3> <"name"> <"number"> <"call-status">

Parameters:
Parameter

1
2
3
name
numbercall-status

Description
VoIP line 1
VoIP line 2
VoIP transfer line
String. Name of caller.
String. Phone number.
Call status as described in the "get status" parameter description.

CLI Format Examples:
get call-info 1
val call-info 1 Blake 7823 connected

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0, VoIP Available in API Version: 1.1

numberDescription:

Query a caller number.

Property Actions:getCommand Definition:
Actionget
response

Definition

get number <1..3>
val number <1..3> <"number">Parameters:

Yamaha CS-700 Integrators Reference Guide

78

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

callerDescription:

Query a caller name.

Property Actions:getCommand Definition:
Actionget
response

Definition

get caller <1..3>
val caller <1..3> <"name">

Parameters:
Parameter

Description
VoIP line 1
VoIP line 2
VoIP line 3 (used for transfer)
Caller's name

1
2
3
name

CLI Format Examples:
get caller 1
val caller 1 Blake

Supported Products: CS700-SP
Available in API Version: 1.1

start-time
Description:

Query call start time. Return value is in format HH:MM:SS in 24-hour time.

Property Actions:getCommand Definition:

Yamaha CS-700 Integrators Reference Guide

79

Actionget
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:getCommand Definition:
Actionget
response

Definition

get codec <1..3>
val codec <1..3> <codec-index>

Parameters:
Parameter

12
3codec-index<0..5>
01
2
3
4
5

Description
VoIP line 1
VoIP line 2
VoIP line 3 (used for transfer)
Codec ID as listed below
Disabled
G.722
G.711U
G.711A
G729
G729

CLI Format Examples:
get codec 1
val codec 1 2

Yamaha CS-700 Integrators Reference Guide

80

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:getCommand Definition:
Actionget
response

Definition

get call-quality <1..3>
val call-quality <1..3> <list>

Parameters:
Parameter

123tx_packets
rx_packets
tx_octetsrx-octets
tx-packet-size
rx-packet-size
lost-packets
discardedpackets
jitter-ms
max-jitter-ms
min-jitter-ms
buffer-level-ms
local-ip
local-port
remote-ip
remote-port

Description
VoIP line 1
VoIP line 2
VoIP line 3 (used for transfer)
Number of transmitted packets
Number of received packets
Number of transmitted octets
Number of received octets
Transmit packet size
Receive packet size
Number of lost packets
Number of discarded packets
Detected jitter in ms
Max detected jitter in ms
Min detected jitter in ms
Jitter buffer size in ms
Local IP address
Local port number
Remote IP address
Remote port number

CLI Format Examples:
get call-quality 1
val call-quality 1
224,227,35840,36320,20,10,12,11,0,20,0,20,200.200.210.131,4000,200.200.210.190,4000

Supported Products: CS700-SP
Available in API Version: 1.1

Yamaha CS-700 Integrators Reference Guide81

5.2.5.2

Call Commands

dial
Description:

Dial of VoIP call with the given number.

Command Definition:
ActionexecuteDefinitiondial<"voip-line-id"> <"number">Parameters:
Parameter1
2
3
NumberDescription
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

answerDescription:

Answer the given call.

Command Definition:
ActionexecuteDefinition

answer <1..2|usb|bt>

Parameters:
Parameterline-id<1..2|usb|bt>

Description
Line ID of call to be answered.

CLI Format Examples:answer1

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0, VoIP(Line ID) Available in API Version: 1.1

hangupDescription:

Hang up the given call.

Yamaha CS-700 Integrators Reference Guide

82

Command Definition:
ActionexecuteDefinition
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:
hangup1

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:
ActionexecuteDefinition
hold<1..2|usb|bt|all>

Parameters:
Parameterline-id<1..2|usb|bt|all>

Description
Line ID of call to be held, or hold all lines

CLI Format Examples:hold1

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0, VoIP(Line ID) Available in API Version: 1.1

resumeDescription:

Resume the given call.

Command Definition:
ActionexecuteDefinition
resume<1..2|usb|bt>

Parameters:

Yamaha CS-700 Integrators Reference Guide

83

Parameterline-id<1..2|usb|bt>

Description
Line ID of call to be resumed

CLI Format Examples:resume1Supported 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:
ActionexecuteDefinitionswap<"held-line-id"> <"active-line-id">

Parameters:
Parameterheld-line-id<1..2|usb|bt>
active-line-id<1..2|usb|bt>

Description
Line ID of call that is currently on hold; this call will be resumed
Line ID of call that is currently active; this call will be placed on hold

CLI Format Examples:
swap

1 2

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0, VoIP(Line ID) Available in API Version: 1.1

join
Description:

Join allows the individual lines to be mixed (joined) or not mixed (separated). Used forconferencing existing calls. Any “line-id” not specified will default to a mix state of 0.

Command Definition:
ActionexecuteDefinition

join <"line-id1" “mix-state”> <"line-id2" “mix_state”> [<"lineid3" “mix_state”>] [<"line-id4" “mix_state”>]

Parameters:
Parameterline-id1<1..2|usb|bt>

Description
Line ID1 of call to be mixed or not mixed

Yamaha CS-700 Integrators Reference Guide84

line-id2<1..2|usb|bt>
line-id3<1..2|usb|bt>
line-id4<1..2|usb|bt>
mix_state01Line 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 conferencejoin

1 0 2 0 usb 0 bt 0

Supported Products: CS700-SP
Available in API Version: 1.1

transfer
Description:

Transfer the source call to target call. The target call was previously initiated and can either
be in an “establishing” state (blind transfer) or a “connected” state (acknowledgedtransfer). After the call has been successfully transferred, both lines are released.

Command Definition:
ActionexecuteDefinitiontransfer<"source-line-id"> <"target-line-id">

Parameters:
Parameter

source-line-id<1..2>
target-line-id<3>

Description
Line ID of call being transferredLine ID of call to which the source will be transferred

CLI Format Examples:
hold 1
dial 3 6175551212
transfer 1 3

Supported Products: CS700-SP
Available in API Version: 1.1

play ring-tone
Description:

Play ring tone by index.

Yamaha CS-700 Integrators Reference Guide

85

Command Definition:
ActionexecuteDefinitionplay 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

Network

5.2.6.1

Network Properties

mac
Description:

Main unit's MAC address. Read-only value set at manufacturing.

Property Actions:getCommand Definition:
Actionget
response

Definition

get macval mac <"mac-address">

Parameters:
Parameter

mac-address

Description
MAC address

CLI Format Examples:
get macval mac AC:14:22:01:23:46

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

dhcp
Description:

Enables or disables DHCP. If DHCP is disabled, the Static IP Address, Subnet Mask, andDefault Gateway must be specified.

Yamaha CS-700 Integrators Reference Guide

86Property Actions:set, get, notify

Default Value:

1

Command Definition:
Actionget
response
set
notifyDefinition

get dhcp
val dhcp <0|1>
set dhcp <0|1>
notify net.dhcp <0|1>

Parameters:
Parameter
01

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.

Property Actions:set, get, notify

Command Definition:
Actionget
response
set
notifyDefinition

get ipval ip <"ip-address">
set ip <"ip-address">
notify net.ip <"ip-address">

Parameters:
Parameter

ip-address

Description
IP address

CLI Format Examples:

Yamaha CS-700 Integrators Reference Guide87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

subnetDescription:

Subnet Mask to determine the subnet to which the device belongs.

Property Actions:set, get, notify

Command Definition:
Actionget
response
set
notifyDefinition

get subnet
val subnet <"subnet-address">
set subnet <"subnet-address">
notify net.subnet <"subnet-address">

Parameters:
Parameter

subnet-address

Description
String. IP address.

CLI Format Examples:
get subnet
val subnet 255.255.255.0
set subnet 255.255.255.0
notify net.subnet 255.255.255.0

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

gateway
Description:

The Default Gateway is the device's default router on the IP network.

Property Actions:set, get, notify

Command Definition:
ActiongetDefinition

get gateway

Yamaha CS-700 Integrators Reference Guide88responseset
notifyval 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.

Property Actions:set, get, notify

Command Definition:
Actionget
response
set
notifyDefinition

get dns1
val dns1 <"dns-address">set dns1 <"dns-address">
notify net.dns1 <"dns-address">

Parameters:
Parameterdns-address

Description
String. IP address.

CLI Format Examples:get dns1
val dns1 192.168.3.45
set dns1 192.168.3.45
notify net.dns1 192.168.3.45

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

Yamaha CS-700 Integrators Reference Guide

89

dns2
Description:

Address of the secondary Domain Name System (DNS) server.

Property Actions:set, get, notify

Command Definition:
Actionget
response
set
notifyDefinition

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.0

vlan
Description:
Property Actions:

Specifies VLAN behavior and support for the device. .
set, get, notify

Default Value:

2

Command Definition:
Actionget
response
set
notifyDefinition

get vlanval vlan <0|1|2>
set vlan <0|1|2>
notify net.vlan <0|1|2>

Parameters:
Parameter
0

Description
Manually specify VLAN ID. If the environment uses Voice VLAN but the Voice VLAN ID
cannot be detected, choose this, and specify the ID in the VLAN ID field, net.vlan-id

Yamaha CS-700 Integrators Reference Guide

90

1
2

Disable VLAN. Switches off VLAN capabilities
Automatically detect VLAN ID. should be used in environments that provide a VoiceVLAN with automatic detection, in which case the device will determine the VLAN
identifier and register in that network

CLI Format Examples:get vlanval 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. If the VLAN mode is automatic, this is the detected VLAN
ID if VLAN is active.

Property Actions:set, get, notify

Default Value:

3

Command Definition:
Actionget
response
set
notifyDefinition

get vlan-id
val vlan-id <1..4094>
set vlan-id <1..4094>
notify net.vlan-id <1..4094>

Parameters:
Parameter
1..4094

Description
VLAN ID

CLI Format Examples:get vlan-id
val vlan-id 3
set vlan-id 3
notify net.vlan-id 3

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

ntp1

Yamaha CS-700 Integrators Reference Guide

91

Description:

Configure first NTP (Network Time Protocol) server address.

Property Actions:set, get, notify

Default Value:

0.pool.ntp.org

Command Definition:
Actionget
response
set
notifyDefinition

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.org

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

ntp2
Description:

Configure second NTP (Network Time Protocol) server address.

Property Actions:set, get, notify

Default Value:

1.pool.ntp.org

Command Definition:
Actionget
response
set
notifyDefinition

get ntp2
val ntp2 <"ntp-address">
set ntp2 <"ntp-address">
notify net.ntp2 <"ntp-address">

Parameters:
Parameter

Description

Yamaha CS-700 Integrators Reference Guide92

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.org

Command Definition:
Actionget
response
set
notifyDefinition

get ntp3
val ntp3 <"ntp-address">
set ntp3 <"ntp-address">
notify net.ntp3 <"ntp-address">

Parameters:
Parameter

ntp-address

Description
String. IP address or URL or DNS name.

CLI Format Examples:
get ntp3
val ntp3 2.pool.ntp.org
set ntp3 2.pool.ntp.org
notify net.ntp3 2.pool.ntp.org

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

ntp4
Description:

Configure fourth NTP (Network Time Protocol) server address.

Property Actions:set, get, notify

Yamaha CS-700 Integrators Reference Guide

93

Default Value:none

Command Definition:
Actionget
response
set
notifyDefinition

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.1x authentication to access the network. When enabled, the 802.1x
authentication type and the required credentials also need to be specified. MD5
authentication requires a username and password.

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get dot1x-enabled
val dot1x-enabled <0|1>
set dot1x-enabled <0|1>
notify net.dot1x-enabled <0|1>

Parameters:
Parameter
01

Description
Disable 802.1x authentication
Enable 802.1x authentication

Yamaha CS-700 Integrators Reference Guide

94

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:
Actionget
response
set
notifyDefinition

get dot1x-identity
val dot1x-identity <"user-name">set dot1x-identity <"user-name">
notify net.dot1x-identity <"user-name">

Parameters:
Parameter

username

Description
String.

CLI Format Examples:get dot1x-identity
val dot1x-identity testuser
set dot1x-identity testuser
notify net.dot1x-identity testuser

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

dot1x-password
Description:

Set a 802.1x authentication password – required for MD5.

Property Actions:set, get, notify

Command Definition:

Yamaha CS-700 Integrators Reference Guide

95

Actionget
response
set
notifyDefinition

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. You must send the "net-commit" command to apply
any changes to the network settings.

Command Definition:
ActionexecuteParameters:

Definition

set net-commit

None

CLI Format Examples:
set net-commit

Supported Products: CS700-AV, CS700-SP
Available in API Version: 1.0

5.2.7

VoIP

5.2.7.1

VoIP Properties

registrar
Description:

The IP address or DNS name of the SIP registrar server. Required for VoIP call support.

Yamaha CS-700 Integrators Reference Guide

96

Property Actions:set, get, notify

Command Definition:
Actionget
response
set
notifyDefinition

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.1

registrar-backup
Description:

The IP address or DNS name of a failover SIP registrar. It should be configured with the
failover or secondary SIP registrar IP address or domain name if applicable. If no failover orsecondary SIP registrar is present in the VoIP infrastructure, this field should be left blank.
When this field is specified, the phone will register with the primary SIP registrar (the'registrar' property) if it is accessible. If the primary SIP registrar becomes inaccessible via
UDP or TCP, the phone will attempt to register with the backup registrar. If the phonesuccessfully registered with the backup registrar, it will switch to the backup registrar to
perform outgoing calls and receive incoming calls. While the phone is registered with the
backup registrar, it will monitor the primary SIP registrar connection. Once the primary SIP
registrar becomes available again, the phone will roll back to register with the primary
registrar and route SIP traffic from/to the primary registrar.

Property Actions:set, get, notify

Command Definition:
Actionget
response
set
notifyDefinition

get registrar-backup
val registrar-backup <"address">
set registrar-backup <"address">
notify voip.registrar-backup <"address">

Yamaha CS-700 Integrators Reference Guide

97

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. The value here must matchthe realm sent by the server in the WWW-Authenticate or Proxy-Authenticate header inthe 401/407 response. An asterisk ('*') causes the endpoint to respond to any realms.

Property Actions:set, get, notify

Default Value:*

Command Definition:
Actionget
response
set
notifyDefinition

get realm
val realm <"realm">
set realm <"realm">
notify voip.realm <"realm">Parameters:
Parameter
realm

Description
Realm string

CLI Format Examples:get realm
val realm *set realm *notify voip.realm *Supported Products: CS700-SP
Available in API Version: 1.1

Yamaha CS-700 Integrators Reference Guide98

proxyDescription:

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 theproxy's address, for example, '10.134.129.101;lr'.

Property Actions:set, get, notify

Command Definition:
Actionget
response
set
notifyDefinition

get proxyval proxy <"sip-proxy">
set proxy <"sip-proxy">
notify voip.proxy <"sip-proxy">

Parameters:
Parameter

Description
String. IP address or name. Separate multiple addresses by a comma. Add ";lr" suffix forloose routing.

sip-proxy

CLI Format Examples:
get proxyval proxy 10.123.234.14;lr
set proxy 10.123.234.14;lr
notify voip.proxy 10.123.234.14;lr

Supported Products: CS700-SP
Available in API Version: 1.1

reg-use-proxy
Description:
Property Actions:Indicates whether the SIP proxy server(s) specified in "proxy" property should be used
when registering. Selecting this option will add the listed proxy server(s) to the route
headers of the SIP REGISTER request.
set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get reg-use-proxyval reg-use-proxy <0..3>
set reg-use-proxy <0..3>
notify voip.reg-use-proxy <0..3>

Yamaha CS-700 Integrators Reference Guide

99

Parameters:
Parameter

Description
No proxy
Outbound only
Acc only
All

0
1
2
3

CLI Format Examples:get reg-use-proxyval 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.

Property Actions:set, get, notify

Command Definition:
Actionget
response
set
notifyDefinition

get userval user <"user-name">
set user <"user-name">
notify voip.user <"user-name">

Parameters:
Parameteruser-name

Description
String. SIP username.

CLI Format Examples:
get userval user testuser
set user testuser
notify voip.user testuser

Supported Products: CS700-SP
Available in API Version: 1.1

Yamaha CS-700 Integrators Reference Guide

100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:
Actionget
response
set
notifyDefinition

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.password 1234

Supported Products: CS700-SP
Available in API Version: 1.1

id
Description:

SIP ID used for SIP registration. If this field is left blank, the voip.user (User name) field will
be used as the ID.

Property Actions:set, get, notify

Command Definition:
Actionget
response
set
notifyDefinition

get idval id <"id">set id <"id">notify voip.id <"id">Parameters:
Parameter

Description

Yamaha CS-700 Integrators Reference Guide

101

id

String. SIP ID.

CLI Format Examples:
get idval 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 noDisplay Name is provided, the User name will be used. Please note that the IP PBX mightoverride the display name sent by the device and replace it with names configured in the
PBX.

Property Actions:set, get, notify

Command Definition:
Actionget
response
set
notifyDefinition

get name
val name <"name">
set name <"name">
notify voip.name <"name">

Parameters:
Parameter
nameDescription
String. VoIP Display Name.

CLI Format Examples:
get name
val name Blake
set name Blake
notify voip.name Blake

Supported Products: CS700-SP
Available in API Version: 1.1

reg-timeout
Description:
Property Actions:Registration Timeout is the optional timeout for SIP account registration, in seconds.
set, get, notify

Yamaha CS-700 Integrators Reference Guide

102

Default Value:

60

Command Definition:
Actionget
response
set
notifyDefinition

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.1

rereg-delay
Description:

Configure auto re-registration retry interval in seconds. If SIP registration is unsuccessful,
this property specified the time duration between retry attempts in seconds.

Property Actions:set, get, notify

Default Value:

300

Command Definition:
Actionget
response
set
notifyDefinition

get rereg-delay
val rereg-delay <1..604800>
set rereg-delay <1..604800>
notify voip.rereg-delay <1..604800>

Parameters:
Parameter

1..604800

Description
Auto re-registration retry interval in seconds

CLI Format Examples:

Yamaha CS-700 Integrators Reference Guide

103

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. If one of the UAs in a call does not receive
the refresh request within the expiration timeout period, it will terminate the session

Property Actions:set, get, notify

Default Value:

1

Command Definition:
Actionget
response
set
notifyDefinition

get use-timer
val use-timer <0|1|2|3>
set use-timer <0|1|2|3>
notify voip.use-timer <0|1|2|3>

Parameters:
Parameter
01
2
3

Description
Inactive. Session Timers will not be used in any session, except if explicitly required in
the remote request
Optional. Session Timers will be used in all sessions whenever the remote supports anduses it
Mandatory. Session Timers support will be a requirement for the remote to be able toestablish a session
Always. Session Timers will always be used in all sessions, regardless whether the
remote supports or uses it or not

CLI Format Examples:
get use-timer
val use-timer 1
set use-timer 1
notify voip.use-timer 1

Supported Products: CS700-SP
Yamaha CS-700 Integrators Reference Guide

104

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 callnegotiation, the nodes will negotiate the expiration period to be used for the session. If thenegotiated value is less than the session timer’s minimum expiration, then the session
timer minimum expiration is used instead. It is measured in seconds.
set, get, notify

Default Value:

1800 (30 minutes)

Command Definition:
Actionget
response
set
notifyDefinition

get timer-se
val timer-se <90..604800>
set timer-se <90..604800>
notify voip.timer-se <90..604800>

Parameters:
Parameter

Description
Session timer in seconds

90..604800

CLI Format Examples:
get timer-se
val timer-se 1800
set timer-se 1800
notify voip.timer-se 1800

Supported Products: CS700-SP
Available in API Version: 1.1

timer-min-se
Description:

SIP session timer minimal expiration period (seconds). This is the minimum period that thedevice will accept when negotiating the expiration period with the remote phone. If thesession timer expiration duration is less than this value, this value is used instead. It ismeasured in seconds.

Property Actions:set, get, notify

Default Value:

90

Command Definition:
ActionDefinition

Yamaha CS-700 Integrators Reference Guide

105

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
notifyParameters:
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. SIP is a request-response type of protocol
with two types of responses: provisional and final. Final responses are sent reliably, using
an ACK to ensure receipt. Provisional responses by default are not sent reliably and do not
require an ACK; however, in some cases, such as for PSTN interoperability support,
reliability of provisional types of responses is needed. Choose this option to add the PRACK(provisional ACK) message support for reliability.

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get use-100rel
val use-100rel <0|1>
set use-100rel <0|1>
notify voip.use-100rel <0|1>

Parameters:
Parameter
01

Description
Disable reliable provisional responses
Enable reliable provisional responses

CLI Format Examples:
get use-100rel

Yamaha CS-700 Integrators Reference Guide

106

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 asymmetric NAT (Network Address Translation). When enabled, the device will keep track of
the public IP address from the response of the REGISTER request. If it detects that theaddress has changed, it will unregister the current Contact, update the Contact with thetransport address obtained from the Via header, and register a new Contact to the SIP
registrar. This option will also update the public name of the UDP transport if STUN is
configured.

Property Actions:set, get, notify

Default Value:

1

Command Definition:
Actionget
response
set
notifyDefinition

get auto-update-nat
val auto-update-nat <0|1>
set auto-update-nat <0|1>
notify voip.auto-update-nat <0|1>

Parameters:
Parameter
01

Description
Disable NAT
Enable NAT

CLI Format Examples:
get auto-update-nat
val auto-update-nat 1
set auto-update-nat 1
notify voip.auto-update-nat 1

Supported Products: CS700-SP
Available in API Version: 1.1

dtmf-method
Description:

DTMF signaling method.

Yamaha CS-700 Integrators Reference Guide

107

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

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-band0
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.
Property Actions:set, get, notify
Default Value:

96

Command Definition:
Actionget
response
set
notifyDefinition

get dtmf-rtp-payload-type
val dtmf-rtp-payload-type <96..127>
set dtmf-rtp-payload-type <96..127>
notify voip.dtmf-rtp-payload-type <96..127>

Parameters:
Parameter
96..127

Description
RTP packet type

CLI Format Examples:get dtmf-rtp-payload-type
val dtmf-rtp-payload-type 96

Yamaha CS-700 Integrators Reference Guide108

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:
Actionget
response
set
notifyDefinition

get media-onhold-method
val media-onhold-method <0|1>
set media-onhold-method <0|1>
notify voip.media-onhold-method <0|1>

Parameters:
Parameter
01

Description
M line only -- RFC3264. Implements the functionality according to RFC3264. In the
INVITE message SDP body, the attribute 'a=sendonly' is set to a designated media
stream to put media on-hold
M and C line -- RFC2543. Implements the functionality according to RFC2543. In the
INVITE message SDP body, the connection line ip is set to '0.0.0.0' (e.g. 'c= IN IP4
0.0.0.0'), and the attribute 'a=inactive' is added

CLI Format Examples:
get media-onhold-method
val media-onhold-method 0
set media-onhold-method 0
notify voip.media-onhold-method 0

Supported Products: CS700-SP
Available in API Version: 1.1

use-srtp
Description:

Controls Secure Real-time Transport Protocol (SRTP) usage.

Property Actions:set, get, notify

Yamaha CS-700 Integrators Reference Guide

109

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get use-srtp
val use-srtp <0|1|2>
set use-srtp <0|1|2>
notify voip.use-srtp <0|1|2>

Parameters:
Parameter
0
1
2

Description
Disabled -- Do not use SRTP; always use RTP
Optional -- Use the optional disposition for SRTP in SDP; if the remote end supports
SRTP then use SRTP; otherwise use RTP
Mandatory -- Force use of SRTP; if the remote end does not support SRTP the call does
not connect

CLI Format Examples:
get use-srtp
val use-srtp 0
set use-srtp 0
notify voip.use-srtp 0

Supported Products: CS700-SP
Available in API Version: 1.1

rtp-port
Description:
Property Actions:Base port number for VoIP RTP. RTP is originated and received on even port numbers, andthe associated RTCP uses the next higher odd port number.
set, get, notify

Default Value:

4000

Command Definition:
Actionget
response
set
notifyDefinition

get rtp-port
val rtp-port <1024..65535>
set rtp-port <1024..65535>
notify voip.rtp-port <1024..65535>

Parameters:
Parameter

1024..65535

Description
Port number

Yamaha CS-700 Integrators Reference Guide110

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 theInternet 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.

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get set-qos
val set-qos <0|1>
set set-qos <0|1>
notify voip.set-qos <0|1>

Parameters:
Parameter
01

Description
Disable QoS
Enable QoS

CLI Format Examples:
get set-qos
val set-qos 0
set set-qos 0
notify voip.set-qos 0

Supported Products: CS700-SP
Available in API Version: 1.1

udp-tcp-selection

Yamaha CS-700 Integrators Reference Guide

111

Description:

Transport that will be used for SIP messages.

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

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
01

Description
UDP
TCP

CLI Format Examples:
get udp-tcp-selection
val udp-tcp-selection 0
set udp-tcp-selection 0
notify voip.udp-tcp-selection 0

Supported Products: CS700-SP
Available in API Version: 1.1

local-port
Description:

Specifies the local port for SIP transport.

Property Actions:set, get, notify

Default Value:

5060

Command Definition:
Actionget
response
set
notifyDefinition

get local-port
val local-port <1024..65535>
set local-port <1024..65535>
notify voip.local-port <1024..65535>

Parameters:
Parameter

Description

Yamaha CS-700 Integrators Reference Guide

112

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-addrDescription:

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..

Property Actions:set, get, notify

Command Definition:
Actionget
response
set
notifyDefinition

get ip-addr
val ip-addr <"ip-address">
set ip-addr <"ip-address">
notify voip.ip-addr <"ip-address">

Parameters:
Parameter

ip-address

Description
IP address

CLI Format Examples:
get ip-addr
val ip-addr 192.168.1.103
set ip-addr 192.168.1.103
notify voip.ip-addr 192.168.1.103

Supported Products: CS700-SP
Available in API Version: 1.1

bound-addr

Yamaha CS-700 Integrators Reference Guide

113

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:
Actionget
response
set
notifyDefinition

get bound-addr
val bound-addr <"ip-address">set bound-addr <"ip-address">
notify voip.bound-addr <"ip-address">

Parameters:
Parameter

Description
IP address

ip-address

CLI Format Examples:
get bound-addr
val bound-addr 192.168.1.103
set bound-addr 192.168.1.103
notify voip.bound-addr 192.168.1.103

Supported Products: CS700-SP
Available in API Version: 1.1

no-refer-sub
Description:

Property Actions:

Enable or disable suppress subscription during transfer. When transferring a SIP call, the SIPREFER process automatically establishes a temporary event subscription to notify the party
initiating the transfer about the receiver's status in handling the REFER. In some cases these
event subscriptions and notifications are not needed, such as when forking is not used.
Enable this option to suppress the automatic event subscriptions when transferring calls.
set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get no-refer-sub
val no-refer-sub <0|1>
set no-refer-sub <0|1>
notify voip.no-refer-sub <0|1>

Parameters:

Yamaha CS-700 Integrators Reference Guide

114

Parameter

Description
Disable suppressing subscription
Enable suppressing subscription

01

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 bein the full name form or in the abbreviated form. Abbreviated form is useful whenmessages might be too large to be carried on the available transport, for example when
exceeding UDP's Maximum Transmission Unit (MTU). Enable this option to encode SIP
headers in their short forms to reduce size. By default, the option is not enabled and SIP
headers in outgoing messages will be encoded in their full names. (See SIP protocol
standard, IETF RFC 3261.)

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get min-size
val min-size <0|1>
set min-size <0|1>
notify voip.min-size <0|1>

Parameters:
Parameter
01

Description
Do not use compact format
Use compact format.

CLI Format Examples:
get min-size
val min-size 0
set min-size 0
notify voip.min-size 0

Yamaha CS-700 Integrators Reference Guide115

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 Routeheader. Older proxies may be strict-routing (see IETF RFC 2543), not supporting loose
routing (see IETF RFC 3261). Enable this option if you are using strict-routing proxies. If thisoption is enabled and you are specifying one or more loose-routing proxies in the Proxyfield, then you must manually add the suffix to each loose-routing proxy address. For
example, “10.134.123.101;lr”.

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get allow-strict
val allow-strict <0|1>
set allow-strict <0|1>
notify voip.allow-strict <0|1>

Parameters:
Parameter

Description
Enable strict routing
Disable strict routing

0
1

CLI Format Examples:
get allow-strict
val allow-strict 0
set allow-strict 0
notify voip.allow-strict 0

Supported Products: CS700-SP
Available in API Version: 1.1

stun-srv
Description:

Specifies the STUN (Session Traversal Utilities for NAT) server IP address or name to use todetermine if the phone is behind a NAT, the type of NAT, and the public address of thephone. The field can contain a comma separated list of servers. Each server can be adomain name, host name, or IP address, and it may contain an optional port number. (ForSTUN see IETF RFC 5389.)

Yamaha CS-700 Integrators Reference Guide

116

Property Actions:set, get, notify

Command Definition:
Actionget
response
set
notifyDefinition

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.15

Supported Products: CS700-SP
Available in API Version: 1.1

use-ice
Description:

Enables the use of the ICE (Interactive Connectivity Establishment) protocol for NAT
traversal. ICE takes advantage of STUN and TURN to identify candidates (IP addresses andports) for communication, evaluating and prioritizing the candidate pairs to select the bestroute. Expensive candidates, such as using a media relay, are selected only as a last resort.
(For ICE see IETF RFC 5245.)

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get use-ice
val use-ice <0|1>
set use-ice <0|1>
notify voip.use-ice <0|1>

Parameters:

Yamaha CS-700 Integrators Reference Guide

117

Parameter

Description
Disable ICE
Enable ICE

01

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. When a candidate isnominated for use, a STUN binding request is sent with a flag indicating that the candidate
pair is nominated.

Property Actions:set, get, notify

Default Value:

1

Command Definition:
Actionget
response
set
notifyDefinition

get ice-regularval ice-regular <0|1>
set ice-regular <0|1>
notify voip.ice-regular <0|1>

Parameters:
Parameter
01

Description
Regular nomination method. CS-700 validates candidate pairs with initial STUN binding
requests, and then selects a valid candidate pair by sending another STUN binding
request with a flag indicating that the pair is nominated.
Aggressive nomination method. CS-700 does not wait to set the nominated flag in asecond STUN binding request, but rather sets the flag in the STUN binding requests forall of the candidate pairs. The ICE processing completes when the first pair successfully
passes connectivity checks. The aggressive method is faster but does not always resultin the optimal path being selected.

CLI Format Examples:
get ice-regularval ice-regular 1

Yamaha CS-700 Integrators Reference Guide118

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. This option specifies the maximum number of local ICE host candidates that may be
used in evaluating candidate pairs when determining the best route.
set, get, notify

Default Value:

5

Command Definition:
ActionGet
Response
Set
NotifyDefinition

get ice-max-hosts
val ice-max-hosts <0..10>
set ice-max-hosts <0..10>
notify voip.ice-max-hosts <0..10>

Parameters:
Parameter

Description
No maximum
Maximum number of host candidates

0
1..10

CLI Format Examples:
get ice-max-hosts
val ice-max-hosts 5
set ice-max-hosts 5
notify voip.ice-max-hosts 5

Supported Products: CS700-SP
Available in API Version: 1.1

ice-no-rtcp
Description:
Property Actions:

Option to not disable the RTCP component in ICE.
set, get, notify

Default Value:0

Yamaha CS-700 Integrators Reference Guide

119

Command Definition:
ActionGet
Response
Set
NotifyDefinition

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

01

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. A TURN relay is
a media relay server residing on the public internet which can relay media data packet
between clients. TURN relays are used when other preferred mechanisms are not available,
such as STUN or direct connectivity. If TURN is enabled, the other TURN settings (server,
username and password) must also be specified.

Property Actions:set, get, notify

Default Value:0

Command Definition:
ActionGet
Response
Set
NotifyDefinition

get use-turnval use-turn <0|1>
set use-turn <0|1>
notify voip.use-turn <0|1>

Parameters:
Parameter
01

Description
Disable TURN
Enable TURN

Yamaha CS-700 Integrators Reference Guide

120

CLI Format Examples:
get use-turnval 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:
ActionGet
Response
Set
NotifyDefinition

get turn-srv
val turn-srv <"address">
set turn-srv <"address">
notify voip.turn-srv <"address">

Parameters:
Parameter
Address

Description
String. The format is either 'DOMAIN:PORT' or 'HOST:PORT'.

CLI Format Examples:
get turn-srv
val turn-srv 200.200.210.153:5349
set turn-srv 200.200.210.153:5349
notify voip.turn-srv 200.200.210.153:5349

Supported Products: CS700-SP
Available in API Version: 1.1

turn-user
Description:

Username to authenticate against the TURN server.

Property Actions:set, get, notify

Command Definition:

Yamaha CS-700 Integrators Reference Guide

121

ActionGet
Response
Set
NotifyDefinition

get turn-user
val turn-user <"user-name">
set turn-user <"user-name">
notify voip.turn-user <"user-name">

Parameters:
Parameteruser-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.

Property Actions:set, get, notify

Command Definition:
ActionGet
Response
Set
NotifyDefinition

get turn-passwd
val turn-passwd <"password">
set turn-passwd <"password">
notify voip.turn-passwd <"password">

Parameters:
Parameter

Password

Description
String.

CLI Format Examples:
get turn-passwd
val turn-passwd 1234
set turn-passwd 1234
notify voip.turn-passwd 1234

Yamaha CS-700 Integrators Reference Guide

122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:
ActionGet
Response
Set
NotifyDefinition

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 TCP01

CLI Format Examples:
get turn-tcp
val turn-tcp 0
set turn-tcp 0
notify voip.turn-tcp 0

Supported Products: CS700-SP
Available in API Version: 1.1

codec1
Description:

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:

1

Command Definition:
ActionGet
Response
Set

Definition

get codec1
val codec1 <0..5>
set codec1 <0..5>

Yamaha CS-700 Integrators Reference Guide

123

notify voip.codec1 <0..5>

NotifyParameters:
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.

Property Actions:set, get, notify

Default Value:

2

Command Definition:
ActionGet
Response
Set
NotifyDefinition

get codec2
val codec2 <0..5>
set codec2 <0..5>
notify voip.codec2 <0..5>

Parameters:
Parameter
0
1
2
3
4
5

Description
None
G.722
G.711 u-law (PCMU)
G.711 A-law (PCMA)
G.726
G.729

Yamaha CS-700 Integrators Reference Guide

124

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 selectedin voip.codec1-voip.codec5.

Property Actions:set, get, notify

Default Value:

3

Command Definition:
Actionget
response
set
notifyDefinition

get codec3
val codec3 <0..5>
set codec3 <0..5>
notify voip.codec3 <0..5>

Parameters:
Parameter
0
1
2
3
4
5

Description
None
G.722
G.711 u-law (PCMU)
G.711 A-law (PCMA)
G.726
G.729

CLI Format Examples:
get codec3
val codec3 3
set codec3 3
notify voip.codec3 3

Supported Products: CS700-SP
Available in API Version: 1.1

codec4

Yamaha CS-700 Integrators Reference Guide

125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:
Actionget
response
set
notifyDefinition

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.codec4 4Supported Products: CS700-SP
Available in API Version: 1.1

codec5
Description:

Lowest 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:

5

Command Definition:
ActiongetDefinition

get codec5

Yamaha CS-700 Integrators Reference Guide126

responseset
notifyval 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 5Supported Products: CS700-SP
Available in API Version: 1.1

ptime
Description:
Property Actions:

The ptime (packetization interval) value for a codec determines the length of time inmilliseconds represented by the media in an RTP packet which is used to transmit audio
traffic.
set, get, notify

Default Value:

20

Command Definition:
Actionget
response
set
notifyDefinition

get ptime
val ptime <10..60>
set ptime <10..60>
notify voip.ptime <10..60>

Parameters:
Parameter
10..60Description
ptime interval in 10 ms increments

CLI Format Examples:
get ptime

Yamaha CS-700 Integrators Reference Guide

127

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.

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get mwival mwi <0|1>
set mwi <0|1>
notify voip.mwi <0|1>

Parameters:
Parameter
01

Description
Disable MWI signaling
Enable MWI signaling

CLI Format Examples:
get mwival mwi 0
set mwi 0
notify voip.mwi 0

Supported Products: CS700-SP
Available in API Version: 1.1

vm-number
Description:

The number that is dialed when voicemail is called from the UI.

Property Actions:set, get, notify

Command Definition:

Yamaha CS-700 Integrators Reference Guide

128

Actionget
response
set
notifyDefinition

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.

Property Actions:get, notify

Command Definition:
Actionget
response
notifyDefinition

get vm-countval vm-count <"vm-count">
notify voip.vm-count <"vm-count">

Parameters:
Parameter

vm-count

Description
Number of VoIP voice mail messages.

CLI Format Examples:get vm-countval vm-count 2
notify voip.vm-count 2

Supported Products: CS700-SP
Available in API Version: 1.1

Yamaha CS-700 Integrators Reference Guide129

do-not-disturb
Description:
Property Actions:

Configure do-not-disturb (DND) setting.
set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

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

01

CLI Format Examples:get do-not-disturb
val do-not-disturb 0
set do-not-disturb 0
notify voip.do-not-disturb 0

Supported Products: CS700-SP
Available in API Version: 1.1

auto-answer
Description:

Auto answer incoming VoIP calls. We recommend enabling this feature only for test
purposes. If the phone is set to Do Not Disturb or if there are no available lines, theForward rules will apply. If there are no Forward rules specified, the incoming call will besent to voice mail. If voice mail is not supported, the call will be rejected.

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get auto-answer
val auto-answer <0|100..699>
set auto-answer <0|100..699>
notify voip.auto-answer <0|100..699>

Yamaha CS-700 Integrators Reference Guide

130

Parameters:
Parameter

Description
Disable auto-answer
RESPONSE to send when answering

0100..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.
set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get duration
val duration <0..10080>
set duration <0..10080>
notify voip.duration <0..10080>

Parameters:
Parameter

0
1..10080

Description
No maximum
Maximum VoIP call duration in minutes

CLI Format Examples:get duration
val duration 0
set duration 0
notify voip.duration 0

Supported Products: CS700-SP
Available in API Version: 1.1

Yamaha CS-700 Integrators Reference Guide

131

dial-plan
Description:

Specifies the VoIP dial plan string. See the User's Guide for a detailed description of dialplan settings.

Property Actions:set, get, notify

Command Definition:
Actionget
response
set
notifyDefinition

get dial-planval dial-plan <"dial-plan">set dial-plan <"dial-plan">
notify voip.dial-plan <"dial-plan">Parameters:
Parameter

Description
Dial plan string.

dialplan

CLI Format Examples:get dial-planval dial-plan 0|[49]xx|1[2-9]xx[2-9]xxxxxx//The following allows only US−style 1 + area−code + local−number, but disallows area codes and local numbers//starting with 0 or 1. It also allows 411, 911, and operator calls (0)set dial-plan 0|[49]xx|1[2-9]xx[2-9]xxxxxx

notify voip.dial-plan 0|[49]xx|1[2-9]xx[2-9]xxxxxx

Supported Products: CS700-SP
Available in API Version: 1.1

always-forwarding
Description:

Enable or disable forwarding all incoming VoIP calls to the specified number.

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get always-forwarding
val always-forwarding <0|1>
set always-forwarding <0|1>
notify voip.always-forwarding <0|1>

Yamaha CS-700 Integrators Reference Guide

132

Parameters:
Parameter
01

Description
DisableEnable

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.

Property Actions:set, get, notify

Command Definition:
Actionget
response
set
notifyDefinition

get always-forwarding-num
val always-forwarding-num <"fwd-number">
set always-forwarding-num <"fwd-number">notify voip.always-forwarding-num <"fwd-number">Parameters:
Parameter

fwd-number

Description
String. VoIP dialing number.

CLI Format Examples:
get always-forwarding-num
val always-forwarding-num 7823
set always-forwarding-num 7823
notify voip.always-forwarding-num 7823

Supported Products: CS700-SP
Available in API Version: 1.1

busy-forwarding

Yamaha CS-700 Integrators Reference Guide

133

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:
Actionget
response
set
notifyDefinition

get busy-forwarding
val busy-forwarding <0|1>
set busy-forwarding <0|1>
notify voip.busy-forwarding <0|1>

Parameters:
Parameter

Description
DisableEnable01

CLI Format Examples:
get busy-forwarding
val busy-forwarding 0
set busy-forwarding 0
notify voip.busy-forwarding 0

Supported Products: CS700-SP
Available in API Version: 1.1

busy-forwarding-num
Description:

Forward 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

Command Definition:
Actionget
response
set
notifyDefinition

get busy-forwarding-num
val busy-forwarding-num <"fwd-number">
set busy-forwarding-num <"fwd-number">notify voip.busy-forwarding-num <"fwd-number">Parameters:
Parameter

Description

Yamaha CS-700 Integrators Reference Guide134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.

Property Actions:set, get, notify

Default Value:0

Command Definition:
Actionget
response
set
notifyDefinition

get noanswer-forwarding
val noanswer-forwarding <0|1>
set noanswer-forwarding <0|1>
notify voip.noanswer-forwarding <0|1>

Parameters:
Parameter
01

Description
DisableEnable

CLI Format Examples:
get noanswer-forwarding
val noanswer-forwarding 0
set noanswer-forwarding 0
notify voip.noanswer-forwarding 0

Supported Products: CS700-SP
Available in API Version: 1.1

noanswer-forwarding-num

Yamaha CS-700 Integrators Reference Guide

135

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:
Actionget
response
set
notifyDefinition

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.

fwd-number

CLI Format Examples:
get noanswer-forwarding-num
val noanswer-forwarding-num 7823
set noanswer-forwarding-num 7823
notify voip.noanswer-forwarding-num 7823

Supported Products: CS700-SP
Available in API Version: 1.1

noanswer-delay
Description:

Number of seconds to wait before forwarding an unanswered incoming call to the'noanswer-forwarding-num' number.

Property Actions:set, get, notify

Default Value:

10

Command Definition:
Actionget
response
set
notifyDefinition

get noanswer-delay
val noanswer-delay <2..30>
set noanswer-delay <2..30>
notify voip.noanswer-delay <2..30>

Parameters:
Parameter
2..30

Description
Seconds to wait before forwarding a call

Yamaha CS-700 Integrators Reference Guide

136

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:
Actionget
response
notifyDefinition

get registration
val registration <0..999>
notify voip.registration <0..999>

Parameters:
Parameter

0
999
200
Code other thanabove

Description
Unregistered to SIP server
Registration is in process
Registered to SIP server
Registration attempt failed

CLI Format Examples:get registration
val registration 999
notify voip.registration 200

Supported Products: CS700-SP
Available in API Version: 1.1

5.2.7.3

VoIP Commands

set dtmf
Description:

Send DTMF digit on given VoIP line during an active call.

Yamaha CS-700 Integrators Reference Guide

137

Command Definition:
ActionexecuteDefinition

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.

Command Definition:
ActionexecuteParameters:

Definition

set voip-commit

None

CLI Format Examples:set voip-commit

Supported Products: CS700-SP
Available in API Version: 1.1

6

Provisioning

Devices that have an IP connection can be provisioned with configuration settings and can be upgraded throughthe use of DHCP options 66 or 150. These DHCP options are used to specify an HTTP, TFTP or FTP server fromwhich a device can download configuration files. These files can also specify a firmware upgrade bundle andversion information.

Yamaha CS-700 Integrators Reference Guide138

When a device starts, it sends a request to the DHCP server for an IP address. In addition to the IP address, thedevice 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.
A TFTP server needs to be configured as:
tftp://<server address>
An HTTP server needs to be configured as:
http://<server address>
An FTP server needs to be configured as:
ftp://<server address>/user=”<username>”&pass=”<password>”
where <username> and <password> are the username and password required to access the FTP server.
Once the CS-700 receives address information for a provisioning server, it tries to access configuration files on thatserver to auto-configure the device. The configuration file for a specific device needs to be named as follows:<MAC-address of device>.xml.
A device provisioning file can include other provisioning files, enabling an organization to construct a hierarchy of
configuration settings. For example, you typically create small device-specific files that contain the few
configuration settings unique to a device. And you create group-specific files that are shared by devices in a group,
and an enterprise-wide file with settings that a shared by the entire enterprise.
Any configuration data provided from the configuration files will overwrite configuration data previously stored on
the device.
A list of the available parameters with a short description is provided below in the section titled, “Provisioning File
Parameters.”

6.1 Provisioning FilesThe provisioning file is in xml format. The syntax of the file is:<provisioning [include=”{comma separated list of include files}”]>[<config {list of config parameters} />][<firmware version=”{firmware version}”>{firmware file name}</firmware>]</provisioning>where [] indicates an optional parameter and {} indicate a description of the content to be provided.
The “config” tag contains all configuration settings that pertain to the device, while the “firmware” tag includes thelatest firmware version and firmware file name.
Sample device configuration file
Filename: F0DEF1A064E6.xml for the unit with the MAC address f0:DE:F1:A0:64:E6

Yamaha CS-700 Integrators Reference Guide139

<provisioning include="enterprise.xml, department.xml"><config voip.id="test" voip.name="test" voip.user="test" voip.password="test" /></provisioning>
Sample enterprise configuration file
Filename: enterprise.xml<provisioning><firmware version="2.6.0.294">CS-700-2-6-0-294.bundle</firmware><config
voip.registrar="200.200.210.240"
voip.registrar-backup=""voip.realm="*"voip.reg-use-proxy="0"
voip.proxy=""/></provisioning>
Sample department configuration file
Filename: department.xml<provisioning><config/></provisioning>

net.ntp1="0.pool.ntp.org"
net.ntp2="1.pool.ntp.org"
sys.provisioning-interval="1440"
voip.ptime="20"
voip.codec1="1"voip.codec2="2"voip.codec3="3"voip.codec4="4"voip.codec5="5"

6.2 Provisioning File Parameters
Property

Type

ValuesDefault Value

Descriptionsys.systemname

TEXT

System name string.
Default value is the
product nameconcatenated with
the MAC address

Product nameand MAC
Address

Specifies the system name.

sys.md5password

TEXT

Password string.

7386 (as MD5sum) seecommandAdministrator password forthe device, stored as MD5
sum.

Yamaha CS-700 Integrators Reference Guide140

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 themicrophone mute buttonon the main unit.
Enable/disable the speakervolume buttons on themain unit.
Enable/disable theBluetooth button on themain unit.
Enable/disable the callstate LED on the main unit.

sys.region

INDEXED_OPTION

1 : Argentina
2 : Australia
3 : Belgium
4 : Brazil
5 : Canada
6 : Chile
7 : China
8 : Costa Rica
9 : France
10 : Germany
11 : Hong Kong
12 : India
13 : Israel
14 : Italy
15 : Japan
16 : Malaysia
17 : Mexico
18 : New Zealand
19 : Singapore
20 : South Africa
21 : Taiwan
22 : United Kingdom
23 : USA
24 : Venezuela

23

Region in which device isoperating, setting by index.

sys.require-https

BOOLEAN0

Configure require httpssettingsys.power-savingmode

BOOLEAN1

Configure power saving
mode setting.

sys.power-savingtime

NUMBER

0 : Do not requireHTTPS
1 : Require HTTPS
0 : Power save mode
is off
1 : Power save mode
is ontimeout : Power savetimeout in minutes

20

Configure power saving
time in minutes.

Yamaha CS-700 Integrators Reference Guide141

sys.provisioninginterval

NUMBER

1..44640 :Provisioning intervalin 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.

publicsys.snmpcontact-name

TEXT

Contact name.

Specifies the SNMP readonly community string used
for queries from the server
and transmitted traps.
Read-only indicates theauthorization level. The
device does not support
write operations initiatedthrough SNMP.
Specifies the contact name,typically the systemadministrator. This string is
informational and can
include an email address. It
is not associated with traps.

sys.snmp-devicelocation

TEXT

Device location.

sys.snmp-address

TEXT

IP address or DNS
name.

sys.recent-callenabled

BOOLEANsys.ui-mask

NUMBER

0 : Disable recent calllist
1 : Enable recent calllist
0 : All menus areenabled in the dialer
4 : Do not allow
modifications of callforwarding
8 : Do not allow
modifications of callhistory
16 : Do not allow
modifications ofcontacts
32 : Do not allow
modifications of DND

Yamaha CS-700 Integrators Reference Guide

1

0

Specifies the location of thedevice for informational
purposes.
Specifies SNMP server
address to which traps will
be sent. Leave blank todisable traps.
Enables or disable the
Recent Calls list.
Enable or disable menus indialer via a bit mask

142

audio.eq

NUMBER

1 : Voice2 : 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

0audio.analogaudio-in-mode

BOOLEAN0audio.analogaudio-in-gain

NUMBER

0 : Automatic gain
setting
1 : Manually specify
gain setting-12.0..40.0 : Manualgain setting

audio.wirelessomni-mic

BOOLEAN0audio.wirelessdirect-mic

BOOLEANaudio.wirelesslapel-mic

BOOLEANaudio.ring-tone

INDEXED_OPTIONTEXT

0 : Disable wirelessomni mic
1 : Enable wirelessomni mic
0 : Disable wirelessdirect mic
1 : Enable wirelessdirect mic
0 : Disable wirelesslapel mic
1 : Enable wirelesslapel mic
0..5 : Ring-tone index

0

VoIP ring-tone selection.

1..18 : Ringer volume
level

13

Configure VoIP ringer
volume.

1..18 : Speak volume
level

13

Configure speaker volume
for calls.

audio.ringervolume
audio.speakervolume

TEXT

Yamaha CS-700 Integrators Reference Guide

4.5

0

0

EQ setting used to adjust
the speaker frequencies toyour preference for theroom and the types of calls.
High-Pass filter setting.
High-Pass filters areprovided to adjust to room
and application
requirements. Use theHigh-Pass filter in rooms
that have a highbackground noise in the
low frequencies (airconditioning, lighting
fixtures, etc.). All filters are
bi-quad filters, reducing thesignal by 6dB per octave.
For the TV audio in port,
select the gain setting
mode, either auto or
manual.
For the TV audio in port, if
analog-audio-in-mode ismanual, then this is thegain value in dB. This value
can be increased or
decreased by 0.5dB.
Enable/disable additional
audio processing for
wireless omni-directional
microphone.
Enable/disable additional
audio processing for
wireless directional
microphone.
Enable/disable additional
audio processing for
wireless lapel microphone.

143

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, andGamma.

bt.bt-enable

BOOLEAN

String format:<"backlight"><"brightness"><"contrast"><"saturation"><"sharpness"><"hue"> <"gamma">
backlight: <0..5>brightness: <0..250>
contrast: <60..140>
saturation: <50..150>
sharpness: <0..255>
hue: <0..180>
gamma: <1..255>
0 : disable
1 : enable

1

Enable or disable Bluetoothbasic-rate.

bt.bt-name

TEXT

Name of device.
Default value is the
product nameconcatenated withthe system's BT MAC
address"Yamaha CS700 " + BT
MAC address

The Bluetooth basic-rate
device name advertisedover the air.

bt.bt-pin

TEXT

pin : 4-digit string

0000

bt.bt-pairtimeout

NUMBER

0 : No timeout
30, 60, 90, 120 :Pairing timeout inseconds

60

The Bluetooth basic-rate
pin for pairing. Pins are 4
digits.
Bluetooth basic-rate pairing
timeout in seconds. After
this time, the pairing mode
will stop.

bt.nfc- enable

BOOLEAN

0 : Disable NFC andNFC LED
1 : Enable NFC andNFC LED1

Yamaha CS-700 Integrators Reference Guide

Default PTZ settings forhome position. When thedevice detects that the
upstream USB connection
has been established,either at startup or after a
USB disconnection, it willrevert to the default PTZ
settings.
Camera's flicker setting.

Enable/disable NFC and theNFC logo LED on the main
unit.

144

bt.bt-callautojoin

BOOLEAN

0 : Disable BT call
auto join
1 : Enable BT call autojoin

0Enable/disable a Bluetooth
call to auto join a USB
based conference when
there is no dialer app inuse.

bt.bt-autounpair-ondisconnect

BOOLEAN

0 : Disable BT auto
unpair on disconnect
1 : Enable BT auto
unpair on disconnect0

Enable/disable whether a
BT device is automaticallyunpaired when it
disconnects from the CS700.

net.dhcp

BOOLEAN

0 : Disable DHCP
1 : Enable DHCP

1

Enables or disables DHCP. If
DHCP is disabled, the Static
IP Address, Subnet Mask,
and Default Gateway mustbe specified.

net.ipTEXT

IP address

net.subnet

TEXT

IP address

net.gateway

TEXT

IP address.

net.dns1

TEXT

IP address.

net.dns2

TEXT

IP address.

net.vlan

INDEXED_OPTION

0 : Manually specify
VLAN ID
1 : Disable VLAN
2 : Automaticallydetect VLAN ID

2net.vlan-id

NUMBER

1..4094 : VLAN ID

3

Yamaha CS-700 Integrators Reference Guide

Current IP Address assigned
to the device.
Subnet Mask to determine
the subnet to which thedevice belongs.
The Default Gateway is thedevice's default router on
the IP network.
Address of the primary
Domain Name System(DNS) server.
Address of the secondary
Domain Name System(DNS) server.
Specifies VLAN behavior
and support for the device.

The manually specified LAN
ID. If the VLAN mode is
automatic, this is thedetected VLAN ID if VLAN is
active.

145

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.1x
authentication

net.dot1xidentity

TEXT

username : String.

net.dot1xpassword

TEXT

password : String.

voip.registrar

TEXT

IP address or DNS
name.

voip.registrarbackup

TEXT

IP address or DNS
name.

voip.realm

TEXT

Realm string.

Yamaha CS-700 Integrators Reference Guide

Configure fourth NTP(Network Time Protocol)server address.
0*

Enables 802.1x
authentication to accessthe network. Whenenabled, the 802.1x
authentication type andthe required credentials
also need to be specified.
MD5 authentication
requires a username andpassword.
Set a 802.1x authentication
identity – required for
MD5.
Set a 802.1x authentication
password – required for
MD5.
The IP address or DNS
name of the SIP registrar
server. Required for VoIP
call support.
The IP address or DNS
name of a failover SIP
registrar.
Realm of the credential toauthenticate against the
VoIP server. The value here
must match the realm sentby the server in the WWWAuthenticate or ProxyAuthenticate header in the401/407 response. An
asterisk ('*') causes theendpoint to respond to any
realms.

146

voip.proxy

TEXT

IP address or name.
Separate multiple
addresses by acomma. Add ";lr"
suffix for loose
routing.

voip.reg-useproxy

INDEXED_OPTION

0 : No proxy
1 : Outbound only
2 : Acc only
3 : Allvoip.user

TEXT

SIP username.

voip.password

TEXT

SIP user password.

voip.id

TEXT

SIP ID.

voip.nameTEXTVoIP Display Name.

Yamaha CS-700 Integrators Reference Guide0

The outbound SIP proxy
server's IP address orname. If there are multiple
SIP proxies, separate theaddresses by a comma.
Also note that if the allow
strict routing option is set
and you have a SIP proxythat is configured for loose
routing, add thedesignation after theproxy's address, forexample,'10.134.129.101;lr'.
Indicates whether the SIP
proxy server(s) specified in"proxy" property should be
used when registering.
Selecting this option will
add the listed proxy
server(s) to the route
headers of the SIPREGISTER request.
SIP username for theaccount used toauthenticate with the SIP
registrar and proxies.
Required for VoIP support.
SIP password for theaccount used toauthenticate with the SIP
registrar and proxies.
Required for VoIP callsupport.
SIP ID used for SIP
registration. If this field isleft blank, the voip.user(User name) field will be
used as the ID.
VoIP Display Name. The
Display Name is shown
when an outbound call ismade. If no Display Name isprovided, the User namewill be used. Please notethat the IP PBX mightoverride the Display namesent by the device andreplace it with names
configured in the PBX.

147

voip.reg-timeout

NUMBER

1..604800 :Registration timeout
in seconds

60

Registration Timeout is theoptional 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 inseconds. If SIP registrationis unsuccessful, thisproperty specified the time
duration between retryattempts in seconds.

voip.use-timer

INDEXED_OPTION

1

Specify the preference forusing SIP session keep-alive
timers.

voip.timer-se

NUMBER

0 : Inactive
1 : Optional
2 : Mandatory
3 : Always
90..604800 : Session
timer in seconds

1800 (30minutes)

The expiration period(seconds) is the interval atwhich the phone willconsider the SIP session
timed out if it does notreceive a refresh message
from the remote phone.

voip.timer-min-se

NUMBER

1..604800 : Minimum
session timer value inseconds

90

SIP session timer minimal
expiration period(seconds). This is theminimum period that thedevice will accept whennegotiating the expiration
period with the remotephone. If the session timer
expiration duration is lessthan this value, this value isused instead. It ismeasured in seconds.

Yamaha CS-700 Integrators Reference Guide

148

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

1voip.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 typeof protocol with two typesof responses: provisionaland final. Final responses
are sent reliably, using an
ACK to ensure receipt.
Provisional responses bydefault are not sent reliably
and do not require an ACK;
however, in some cases,
such as for PSTN
interoperability support,
reliability of provisional
types of responses isneeded. Choose this option
to add the PRACK(provisional ACK) message
support for reliability.
Configure whether SIP
traversal behind NAT isdisabled. Used for device
behind a symmetric NAT(Network Address
Translation). Whenenabled, the device willkeep track of the public IP
address from the responseof the REGISTER request. If
it detects that the address
has changed, it willunregister the current
Contact, update theContact with the transport
address obtained from theVia header, and register a
new Contact to the SIP
registrar. This option will
also update the publicname of the UDP transport
if STUN is configured.
DTMF signaling method.

Specify the dynamic RTP
payload type for DTMF
transport using RTP.

149

voip.mediaonhold-method

BOOLEAN

0 : M line only -RFC3264
1 : M and C line -RFC2543

0

The Media on Hold method
setting allows switching theMedia on Hold behavior
between the different RFC
definitions.

voip.use-srtp

INDEXED_OPTION

0 : Disabled -- Do not
use SRTP; always use
RTP
1 : Optional -- Use theoptional disposition
for SRTP in SDP; if theremote end supports
SRTP then use SRTP;
otherwise use RTP
2 : Mandatory -Force use of SRTP; if
the remote end does
not support SRTP thecall does not connect0

Controls Secure Real-time
Transport Protocol (SRTP)
usage.

voip.rtp-port

NUMBER

1024..65535 : Port
number4000

Base port number for VoIP
RTP. RTP is originated andreceived on even port
numbers, and theassociated RTCP uses thenext higher odd port
number.

Yamaha CS-700 Integrators Reference Guide

150

voip.set-qos

BOOLEAN

0 : Disable QoS
1 : Enable QoS

0voip.udp-tcpselection
voip.local-port

BOOLEAN

0 : UDP1 : TCP
1024..65535 : Port
number0

voip.ip-addr

TEXT

ip-address : IPaddressvoip.bound-addr

TEXT

voip.no-refer-sub

BOOLEAN

ip-address : IPaddress
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. For layer
3, at the Internet layer, the
DiffServ (DifferentiatedServices) precedence levelis 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.
Transport that will be used
for SIP messages.
Specifies the local port for
SIP transport.
Configure optional address
to advertise as the addressof 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..
Configure bound IP address
we intend to use.
Enable or disable suppress
subscription duringtransfer. When transferring
a SIP call, the SIP REFER
process automaticallyestablishes a temporary
event subscription to notify
the party initiating thetransfer about thereceiver's status in handling
the REFER. In some cases
these event subscriptions
and notifications are notneeded, such as when
forking is not used. Enable
this option to suppress theautomatic event
subscriptions whentransferring calls. (See IETF
RFC 4488.)

151

voip.min-size

BOOLEAN

0 : Do not use
compact format
1 : Use compact
format.

0

voip.allow-strict

BOOLEAN

0 : Enable strictrouting
1 : Disable strictrouting0

Yamaha CS-700 Integrators Reference Guide

Use compact SIP message
format. The SIP protocol
specifies that header fieldnames can be in the fullname form or in theabbreviated form.
Abbreviated form is usefulwhen messages might be
too large to be carried on
the available transport, forexample when exceeding
UDP's Maximum
Transmission Unit (MTU).
Enable this option to
encode SIP headers in theirshort forms to reduce size.
By default, the option is notenabled and SIP headers inoutgoing messages will be
encoded in their fullnames. (See SIP protocol
standard, IETF RFC 3261.)
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 toeach proxy address when
the proxy is added to the
SIP Route header. Older
proxies may be strictrouting (see IETF RFC
2543), not supporting loose
routing (see IETF RFC
3261). Enable this option if
you are using strict-routing
proxies. If this option isenabled and you are
specifying one or moreloose-routing proxies in the
Proxy field, then you must
manually add the suffix toeach loose-routing proxyaddress. For example,“10.134.123.101;lr”.

152

voip.stun-srv

TEXT

stun-address : String.
IP address, domain
name, or host name,and optional port
number. Separate
multiple addresses bycomma.

voip.use-ice

BOOLEAN

0 : Disable ICE
1 : Enable ICE

0voip.ice-regular

BOOLEAN

0 : Regularnomination method
1 : Aggressive
nomination method

1

Yamaha CS-700 Integrators Reference Guide

Specifies the STUN (Session
Traversal Utilities for NAT)
server IP address or nameto use to determine if thephone is behind a NAT, thetype of NAT, and the public
address of the phone. The
field can contain a comma
separated list of servers.
Each server can be adomain name, host name,or IP address, and it may
contain an optional port
number. (For STUN see IETF
RFC 5389.)
Enables the use of the ICE(Interactive Connectivity
Establishment) protocol for
NAT traversal. ICE takes
advantage of STUN and
TURN to identify
candidates (IP addresses
and ports) for
communication, evaluating
and prioritizing thecandidate pairs to selectthe best route. Expensive
candidates, such as using a
media relay, are selected
only as a last resort. (ForICE see IETF RFC 5245.)
ICE nomination method.
When using ICE, select thepreferred ICE Nomination
Method. To validate
candidate pairs (IPaddresses and ports for the
local and remote nodes),CS-700 sends STUN
binding requests as part ofthe media connectivity
tests. When a candidate isnominated for use, a STUN
binding request is sent witha flag indicating that thecandidate pair isnominated.

153

voip.ice-maxhosts

NUMBER

0 : No maximum
1..10 : Maximum
number of hostcandidates

5voip.ice-no-rtcp

BOOLEAN0

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.turn-tcp

BOOLEAN

0 : Do not use TCP;
use UDP1 : Use TCP

Yamaha CS-700 Integrators Reference Guide

00

Maximum number of ICE
host candidate. An ICE hostcandidate is an actual local
transport address in thehost. Host transport
addresses are obtained bybinding to attachednetwork interfaces. These
interfaces include both
physical interfaces andvirtual interfaces such as
VPN. This option specifies
the maximum number of
local ICE host candidates
that may be used in
evaluating candidate pairs
when determining the bestroute.
Option to not disable the
RTCP component in ICE.

Enables the use of a TURN
(Traversal Using Relay NAT)
relay when using ICE. A
TURN relay is a media relay
server residing on the
public internet which canrelay media data packet
between clients. TURN
relays are used when otherpreferred mechanisms are
not available, such as STUN
or direct connectivity. If
TURN is enabled, the other
TURN settings (server,
username and password)
must also be specified.
TURN server domain nameor hostname, and port. The
format is either'DOMAIN:PORT' or'HOST:PORT'
Username to authenticate
against the TURN server.
Password to authenticate
against the TURN server.
Configure whether to use
TCP on TURN relay;
otherwise use UDP.

154

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

2Second highest prioritized
codec. At least one codec
different from “None” hasto be selected in
voip.codec1-voip.codec5.

voip.codec3

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

3

Third highest prioritized
codec. At least one codec
different from “None” hasto be selected in
voip.codec1-voip.codec5.

voip.codec4

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

4

Fourth highest prioritized
codec. At least one codec
different from “None” hasto be selected in
voip.codec1-voip.codec5.

voip.codec5

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

5

Lowest prioritized codec. At
least one codec different
from “None” has to be
selected in voip.codec1voip.codec5.

Yamaha CS-700 Integrators Reference Guide

155

voip.ptime

NUMBER

10..60 : ptime interval
in ms

20

The ptime (packetizationinterval) value for a codec
determines the length oftime in milliseconds
represented by the media
in an RTP packet which isused to transmit audio
traffic.

voip.mwi

BOOLEAN

0 : Disable MWI
signaling
1 : Enable MWI
signaling0

voip.vm-number

TEXT

VoIP voicemail
number.

voip.do-notdisturb

BOOLEAN

0 : Disable DND
1 : Enable DND

0Enable displaying themessage waiting indicator(MWI) on the device andenable receiving message
waiting notifications fromthe PBX. The PBX must be
configured to support voice
mail for the registered user
in order for this feature towork properly.
The number that is dialed
when voicemail is calledfrom the UI.
Configure do-not-disturb(DND) setting.

voip.auto-answer

NUMBER

0 : Disable autoanswer
100..699 : RESPONSE
to send whenanswering0

voip.duration

NUMBER

0 : No maximum
1..10080 : Maximum
VoIP call duration inminutes0voip.dial-planTEXT

dialplan : Dial plan
string.

Yamaha CS-700 Integrators Reference Guide

Auto answer incoming VoIP
calls. We recommend
enabling this feature only
for test purposes. If thephone is set to Do Not
Disturb or if there are noavailable lines, the Forward
rules will apply. If there are
no Forward rules specified,the incoming call will besent to voice mail. If voice
mail is not supported, thecall will be rejected.
Specifies the maximum
VoIP call duration inminutes. When the callduration reaches the
maximum duration, the callwill be automaticallyterminated.

Specifies the VoIP dial plan
string. See the User's Guide
for a detailed description ofdial plan settings.

156

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 towait before
forwarding a call

0

0

0

10

Enable or disableforwarding all incoming
VoIP calls to the specified
number.
Forward all incoming VoIP
calls to the specified
number.
Enable or disableforwarding incoming calls
to the specified number if
the local phone is in 'Do
Not Disturb' mode or if
both lines are busy.
Forward incoming calls tothe specified number if thelocal phone is in 'Do Not
Disturb' mode or if bothlines are busy.
Enable or disableforwarding incoming VoIP
calls to the specified
number if the call is not
answered within the
duration specified in the'noanswer-delay' attribute.
Forward incoming VoIP
calls to the specified
number if the call is not
answered within the
duration specified in the'noanswer-delay' attribute.
Number of seconds to wait
before forwarding anunanswered incoming callto the 'noanswerforwarding-num' number.

SNMP

The CS-700 includes an SNMP agent that can be configured to provide SNMP support.
The table below describes the SNMP configuration settings that the CS-700 administrator must configure to enableSNMP.
snmp-enable

Enable or disable SNMP support. Disabled (0) means that SNMP is notsupported. Enabled (1) means that SNMP is available.

snmp-address

Specifies SNMP server address to which traps will be sent. Leave blank todisable traps.

Yamaha CS-700 Integrators Reference Guide157

snmp-community

Specifies the SNMP read-only community string used for queries from theserver and transmitted traps. Read-only indicates the authorization level.
The device does not support write operations initiated through SNMP.

snmp-contact-nameSpecifies the contact name, typically the system administrator. This stringis informational and can include an email address. It is not associated withtraps.

snmp-device-location

Specifies the location of the device for informational purposes.

The following read-only properties and traps are supported.
Read-only Properties
•
•
•
•
•
•
•
•
•

Serial number
MAC address
Base FW version
USB connection active (0,1)
USB microphone audio stream active (0,1)
USB speaker audio stream active (0,1)
USB video stream active (0,1)
Bluetooth connection active (0,1)
VoIP call active (0,1)

Traps
•

USB connection state changes

Below is the SNMP MIB for the CS-700.
CS700-MIB DEFINITIONS ::= BEGIN
IMPORTSOBJECT-TYPE, NOTIFICATION-TYPE, MODULE-IDENTITY, enterprises FROM
SNMPv2-SMI
OBJECT-GROUP FROM SNMPv2-CONF
DisplayString FROM SNMPv2-TC;
yamahaAgentMIB MODULE-IDENTITY
LAST-UPDATED "201710010000Z"ORGANIZATION "www.uc.yamaha.com"
CONTACT-INFO"postal: Yamaha Unified Communications
144 North Rd
Sudbury, MA 01776
email: uc-customersupport@music.yamaha.com"
DESCRIPTION"Defines monitoring structures for the Yamaha SNMP agent for CS-700."
REVISION "201710010000Z"DESCRIPTION "Initial revision"::= { enterprises 1182 }Yamaha CS-700 Integrators Reference Guide158

cs700OBJECT 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 12}
usbConnection OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION"USB connection active (0,1) of type String."::= {cs700 13}
usbMicStream OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION"USB microphone audio stream active (0,1) of type String."::= {cs700 14}
usbSpkStream OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION"USB speaker audio stream active (0,1) of type String."::= {cs700 15}
usbVidStream OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION"USB video stream active (0,1) of type String."
Yamaha CS-700 Integrators Reference Guide

159

::= {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."::= {cs700 18}--- CS-700 traps-usbConnTrap OBJECT-TYPE
SYNTAX
DisplayString
MAX-ACCESS accessible-for-notify
STATUS
current
DESCRIPTION "USB connection trap data"::= { cs700TrapsObjects 1 }usbConnTrapHit NOTIFICATION-TYPEOBJECTS{ usbconnTrap }STATUS
current
DESCRIPTION "Generated when USB connection state changes"::= { cs700Traps 1 }END

Yamaha CS-700 Integrators Reference Guide

160

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 areshown in column MAC.

Yamaha CS-700 Integrators Reference Guide

161

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, Crestrondevice must repeatedly attempt the telnet/SSH connection till the connection is re-established.
2- On a reconnection with CS-700, Crestron device must provide username and password as in IP
Interface.
3- On a successful login, Crestron device must issue the following commands:a. regnotify
b. set dialer-connection-mode rc
4- Crestron device must issue “get registration” and receive a reply “val registration 200” before
attempting SIP calls.
Note that on a power-up, CS-700 will come up un-registered with SIP server. SIP registration procedure
begins when the Crestron device issues “set dialer-connection-mode rc” command in the steps above.

The following examples show how a typical dialer state machine will control the CLI to make calls and tomix them in a conference.

Make two calls then conference them
The user makes a call to 1234 on line 1, then puts the call on hold. The user then makes a call to7890 on line 2, then creates a conference between line 1 and line 2.
dial 1 1234
hold 1
dial 2 7890
Held calls cannot be conferenced, user must have both calls active before initiating a
conference bridge.
resume 1
join 1 1 2 1
Since USB and Bluetooth are both optional in the join, join 1 1 2 1 is identical to join 1 1 2 1 usb
0 bt 0.
Hold calls in conference

Yamaha CS-700 Integrators Reference Guide

162

The hold command automatically removes calls from conference, but if you just send the holdcommand for line 1, line 2 will remain in conference. It is best practice to send the joincommand to split the conference first.
join 1 0 2 0
hold 1hold 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.
resume 1
resume 2
join 1 1 2 1
Remove calls from conference and leave one call active
A single line cannot be put into a conference with the join command. Similarly, a single line
cannot be left in a conference with the join command. Commands join 1 1 2 0 and join 1 0 2 1
will also remove both calls from the conference.
Similarly, if no calls are in the conference, join 1 1 2 0 does not change the line 1 status toindicate that it’s in conference. If no calls are in the conference, join 1 0 2 1 does not change
the line 2 status to indicate that it’s in conference.
Following is the correct way to remove calls from conference.
join 1 0 2 0
At this point both calls are connected to the speaker and microphone locally, but they do notsend audio to each other. Note, leaving two lines in active state without holding either or bothwill produce undefined telephony behavior.
hold 2At this point, line 1 remains active, and line 2 goes on hold.
Answer SIP calls with active USB line, then conferencing all of them together

Yamaha CS-700 Integrators Reference Guide

163

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 online 2.
hold usb
answer 1
At the point, SIP line 1 is in active state, and the USB line is in hold state.
hold 1At 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 may now initiate a conference. Note, held calls cannot be added in a conference.
resume 1
resume usb
join 1 1 2 1 usb 1
At this point, all calls (USB, line 1, and line 2) are in a conference.
Hold only one callStarting from the previous example, the user puts line 1 on hold.
hold 1
Because a held call cannot be in conference, this automatically removes line 1 from theconference.
At this point, calls (USB, line 2) are in an active conference, and line 1 in on hold, outside theconference.
Hold all calls
The user starts with all lines in conference.
hold allAt this point, all lines are on hold, and not in conference.
Resume calls and conference them

Yamaha CS-700 Integrators Reference Guide

164

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 twolines 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.
join 1 1 2 1 usb 1
At this point, all lines are in active state in the conference
Hangup a call in conference
The user starts with line 1 and USB in an active conference.
hangup 1
At this point, line1 is disconnected and removed from conference, but USB is still in conference.
join 1 0 2 0 usb 0
At this point, USB is active and outside the conference.

Yamaha CS-700 Integrators Reference Guide

165