The guide describes the API for on-premise registered video conferencing devices (CUCM, VCS) as well as devices registered to Cisco’s cloud service (Cisco Webex).

Which commands are available depends on the product, the back-end (on-premise, cloud), and the user role of the local user (admin, audit, integrator, roomcontrol, user). To get an overview of the commands, see the

“Supported commands matrix” on page 486

xConfiguration xCommand

This guide applies to the following products:

• MX Series:

• MX200 G2

• MX300 G2

• MX700

• MX800

• SX Series:

• SX10 Quick Set

• SX20 Quick Set

• SX80 Codec

• Room Series:

• Room Kit

• Room Kit Mini

• Codec Plus 1

• Codec Pro 2

• Room 55

• Room 55 Dual

• Room 70

• Room 70 G2

• Desk Series / DX Series:

• Desk Pro

• DX70

• DX80

• Webex Boards:

• Webex Board 55 and 55S

• Webex Board 70 and 70S

• Webex Board 85S

API Reference Guide

Appendices xStatus

Downloading the user documentation

You can download the user documentation from the Cisco web site, go to:

 https://www.cisco.com/go/telepresence/docs

For Cisco Webex registred devices, go to:

 https://help.webex.com

Guidelines for how to find the documentation on the Cisco web site are included in the



User documentation on the

Cisco web site

appendix.

1 Included in Room Kit Plus and Room Kit Plus Precision 60

2 Included in Room Kit Pro and Room Kit Pro Precision 60

Cisco Collaboration Endpoint Software



Introduction About the API

What’s new in CE9.12

This section provides an overview of the new and changed device settings, and the new features and improvements in the Cisco Collaboration Endpoint software version 9.12 (CE9.12) compared to CE9.10.

The following Webex products are new in CE9:

• CE9.0 - Room Kit

• CE9.1 - Codec Plus, and Room 55

• CE9.2 - Room 70

• CE9.4 - Codec Pro, Room 70 G2, and Room 55 Dual

• CE9.6 - Room Kit Mini

• CE9.8 - Board 55/55S, Board 70/70S, and Board 85S

• CE9.12 - Desk Pro, Room USB

For more details, we recommend reading the Software release notes:

 https://www.cisco.com/c/en/us/support/collaboration-endpoints/telepresence-quick-set-series/ products-release-notes-list.html

xConfiguration xCommand xStatus

API Reference Guide

Appendices

New features and improvements in CE9.12

New products

• Cisco Webex Room USB

• Cisco Webex Desk Pro

DX Series renamed to Desk Series

The new Desk Series contains the DX70, DX80, and Desk Pro products.

Support for using Room Kit Mini with Samsung Flip

(Room Kit Mini)

The Room Kit Mini can be connected with a Samsung Flip device to get a touch interface. Then, you can also use the whiteboard feature. You can easily switch between the Samsung Flip and the Room Kit Mini user interfaces by pressing the Flip button.

One-way whiteboard sharing in-call (Boards)

You can now share the whiteboard while in-call. To initiate this, click the Home button followed by the Whiteboard button. Enter Editing mode and the sharing will begin. To stop the whiteboard sharing, press the Done button, followed by

Stop sharing .

Note that the whiteboard share is one-way. Only the device sharing the whiteboard can draw on the whiteboard. Remote participants can only observe.

Webex Join support for Personal Meeting Room IDs

(All Products)

The Webex Join button now supports dialing Personal

Meeting Room (PMR) IDs. You can address them by entering the full URL or a short path (i.e., username.sitename); as well as, by entering the meeting number.

PMRs from your recent calls list will be suggested as you type.

HTTP proxy support for Webex Edge for Devices

(All products)

HTTP Proxy support has been enhanced to include devices linked to Webex Edge for Devices .

Webx Edge for Device s can select the HTTP Proxy services for the HttpClient, HttpFeedback, and/or the WebEngine.

If so enabled, all HTTP requests to the Webex Cloud will use the configured HTTP Proxy. However, regardless of the Proxy

Mode, the device will never communicate with the Cisco

Unified Communication Manager (CUCM), MRA (CUCM via

Expressway), or TMS (phonebook) via proxy.

In addition, the following new configurations allow you to enable/disable use of the HTTP Proxy:

• xConfiguration HttpClient UseHttpProxy

• xConfiguration HttpFeedback UseHttpProxy

• xConfiguration WebEngine UseHttpProxy

Cisco Collaboration Endpoint Software



Introduction About the API

In-call touch forwarding

(Boards)

Touch forwarding has been enabled for use while in-call and can be activated and deactivated using a floating toolbar.

Hide Proximity notifications (All products)

You can now hide the Proximity notifications. This includes the Proximity icon that is visible on-screen when someone is paired with Proximity and the notification that appears when someone has just paired.

This can be configured via the API or the web interface of the device, or it can be provisioned (e.g., via TMS).

Hide scheduled meeting titles

(All products)

A setting has been added to hide/show the scheduled meeting titles. When hidden, the words “Scheduled meeting” will be displayed instead of the meeting information.

Increased manual zoom range

(Room Kit Mini, Room Kit and Room 55)

The manual zoom range is increased from 2x (Room Kit

Mini) / 3x (Room Kit, Room 55) to 5x. The automatic best overview or speaker track zoom range is not changed.

xConfiguration xCommand

Improvements for the Call Control page in the web interface of the device (All products)

• On a SpeakerTrack-enabled device, a button can be used to alter the current SpeakerTrack status. Click the button to disable or enable SpeakerTrack.

• The Mute button will correctly reflect the mute status of the microphones.

• When a preset is selected and accepted by the video device, it will be highlighted in blue. This includes selection from other devices, such as the Touch 10 controller.

Note that preset highlighting and detection occurs only if the Camera Positions window is open.

• On devices where PresenterTrack is configured, it can be enabled from the Camera Positions window.

• For cases where the main video consists of a composited image of more than one input source, the

DefaultMainVideo source will be displayed. By default, this is the main camera. This requires the remote monitoring option key.

• Regarding the display of directory entries, recent calls, and favorite entries, the maximum number that can be displayed at one time is increased from 50 to 100. The search field can be used to narrow down the list.

xStatus

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xConfiguration changes in CE9.12

New configurations

Audio Input WebView [1] Mode

(Codec Pro, Room 70 G2)

BYOD TouchForwarding Enabled

(Board 55S, Board 70S, Board 85S)

Cameras Camera [1..3] Flip (Codec Plus, Room 55D, Room 70)

Cameras Camera [1..7] Flip (Room 70 G2)

Cameras SpeakerTrack ConnectorDetection * (Codec Plus)

Cameras SpeakerTrack TrackingMode (Codec Plus)

HttpClient UseHttpProxy (All products)

HttpFeedback UseHttpProxy (All products)

NetworkServices SMTP * (Room Kit Mini)

SIP TlsVerify (All products)

Standby Signage InteractionMode

(Room Kit Mini)

SystemUnit State CameraLid (DX80, DX70)

UserInterface Bookings Visibility Title (All products)

UserInterface Diagnostics Notifications (All products)

UserInterface Features Call Keypad (All products)

UserInterface Proximity Notifications (All products)

UserInterface Whiteboard ActivityIndicators

(All products)

Video Output Connector [n] Location HorizontalOffset (Codec Pro, Codec Plus, Room Kit, Room 55,

Room 55D, Room 70, Room 70 G2, SX80, SX20, MX700, MX800, MX200 G2, MX300 G2)

Video Output Connector [n] Location VerticalOffset

(CCodec Pro, Codec Plus, Room Kit, Room 55, Room

55D, Room 70, Room 70 G2, SX80, SX20, MX700, MX800, MX200 G2, MX300 G2)

VoiceControl Wakeword Mode (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D,

Room 70, Room 70 G2, Boards)

WebEngine UseHttpProxy

(Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room 70,

Room 70 G2, Boards) xCommand xStatus

Configurations that are removed

NetworkServices SNMP Host [1..3] Address

(All products)

Configurations that are modified

Network [1] QoS Diffserv Audio (All products)

OLD: Default: 0

NEW: Default: 46

Network [1] QoS Diffserv Data

(All products)

OLD: Default: 0

NEW: Default: 34

Network [1] QoS Diffserv Signalling (All products)

OLD: Default: 0

NEW: Default: 24

Network [1] QoS Diffserv Video (All products)

OLD: Default: 0

NEW: Default: 34

NetworkServices SMTP Username (Boards, DX80, DX70)

OLD: String (0, 50)

NEW: String (0, 80)

SerialPort BaudRate (Codec Pro, Room 70 G2)

OLD: Valuespace: 115200

NEW: Valuespace: 9600/19200/38400/57600/115200

<path> * means that the change applies to all configurations starting with <path>.

D15407.13 Cisco Collaboration Endpoint Software API Reference Guide CE9.12, APRIL 2020 7

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xCommand changes in CE9.12

New commands

Network SMTP VerifyConfig

(Room Kit Mini,Boards, DX80, DX70)

Network Wifi * (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room 70, Room 70 G2,

Boards, DX80, DX70)

Webex Join (All products)

Webex Registration ConvertToCloud (All products)

Commands that are removed

None.

Commands that are modified

Audio Diagnostics Advanced Run (All products)

NEW: Channel: Integer (0..13), Default: 0

NEW: Output: HDMI/Line/Internal/Headset/All, Default: All

Audio Diagnostics MeasureDelay (All products)

OLD: HDMI: All/HDMI/Internal/Line

NEW: HDMI: All/HDMI/Headset/Internal/Line

Audio LocalInput AddConnector (Codec Pro, Room 70 G2)

OLD: ConnectorType: ARC/HDMI/Microphone

NEW: ConnectorType: ARC/HDMI/Microphone/WebView

Audio LocalInput RemoveConnector (Codec Pro, Room 70 G2)

OLD: ConnectorType: ARC/HDMI/Microphone

NEW: ConnectorType: ARC/HDMI/Microphone/WebView

CallHistory Get

(All products)

OLD: Filter: All/AnsweredElsewhere/Forwarded/Missed/NoAnswer/Placed/Received/

Rejected/UnacknowledgedMissed

NEW: Filter: All/AnsweredElsewhere/Forwarded/Missed/NoAnswer/Placed/Pmr/Received/

Rejected/UnacknowledgedMissed

API Reference Guide

Appendices xCommand xStatus

CallHistory Recents

(All products)

OLD: Filter: All/AnsweredElsewhere/Forwarded/Missed/NoAnswer/Placed/Received/

Rejected/UnacknowledgedMissed

NEW: Filter: All/AnsweredElsewhere/Forwarded/Missed/NoAnswer/Placed/Pmr/Received/

Rejected/UnacknowledgedMissed

Presentation Start (All products)

OLD: Layout: Default: none

NEW: Layout: Default: Equal

Presentation Start

(Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room 70,

Room 70 G2)

OLD: PresentationSource: Integer (1..n)

NEW: PresentationSource: None/1/2/../n

SystemUnit Boot (All products)

NEW: Force: False/True, Default: True

UserInterface Extensions Panel Update (All products)

NEW: Color: String (0, 255), Default: none

NEW: Icon: Briefing/Camera/Concierge/Disc/Handset/Help/Helpdesk/Home/Hvac/Info/

Input/Language/Laptop/Lightbulb/Media/Microphone/Power/Proximity/Record/Spark/Tv/

Webex/General, Default: none

NEW: Visibility: Auto/Hidden, Default: none

OLD: Name: required parameter

NEW: Name: optional parameter

<path> * means that the change applies to all configurations starting with <path>.

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xStatus changes in CE9.12

New statuses

Audio Input Connectors USBC [n] Mute

(All products)

Conference Presentation LocalInstance [n] DirectShare (Codec Pro, Codec Plus, Room Kit, Room Kit

Mini, Room 55, Room 55D, Room 70, Room 70 G2, Boards)

Conference SelectedCallProtocol (All products)

MediaChannels DirectShare [n] *

(Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D,

Room 70, Room 70 G2, Boards)

Network [n] Wifi * (All products)

RoomAnalytics Engagement CloseProximity (Room Kit, Room Kit Mini, Room 55, Boards)

UserInterface Features Call Keypad (All products)

UserInterface OSD Output (All products)

Video Input DirectShare [n] Peer Address (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55,

Room 55D, Room 70, Room 70 G2, Boards)

Video Input DirectShare [n] Peer PeripheralID (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55,

Room 55D, Room 70, Room 70 G2, Boards)

Video Input DirectShare [n] Type (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D,

Room 70, Room 70 G2, Boards)

Webex Services Proximity GuestToken (All products)

Statuses that are removed

Audio Input Connectors ARC [n] EcReferenceDelay (All products)

Audio Input Connectors HDMI [n] EcReferenceDelay

(All products)

Audio Output Connectors Line [n] ConnectionStatus

(Codec Pro, Room Kit Mini, Room 70 G2) xStatus Security FIPS Mode (All products) xCommand xStatus

API Reference Guide

Appendices

Statuses that are modified

Diagnostics Message [n] Type

(All products)

Added to valuespace: AmplifierDetection/AmplifierFanStatus/CurrentNetworkQuality/

KioskModeFailedToLoad/LowBattery/MissingDisplay/MissingThirdDisplay/

PanoramaCameraHdmi/PanoramaView/PeripheralSoftwareUpgrade/

WebexEdgeAccountPendingCloudRegistration

Peripherals ConnectedDevice [n] Type (All products)

OLD: Byod/Camera/ControlSystem/ISDNLink/InputDevice/Other/SpeakerTracker/

TouchPanel

NEW: Byod/Camera/ControlSystem/Headset/ISDNLink/InputDevice/Other/SpeakerTracker/

TouchPanel

Proximity Services Availability (All products)

OLD: Available for on-premises registered devices

NEW: Available for both on-premises and Webex cloud registered devices

<path> * means that the change applies to all configurations starting with <path>.

Cisco Collaboration Endpoint Software



Introduction About the API

What’s new in CE9.10

This section provides an overview of the new and changed device settings, and the new features and improvements in the Cisco Collaboration Endpoint software version 9.10 (CE9.10) compared to CE9.9.

The following Webex products are new in CE9:

• CE9.0 - Room Kit

• CE9.1 - Codec Plus, and Room 55

• CE9.2 - Room 70

• CE9.4 - Codec Pro, Room 70 G2, and Room 55 Dual

• CE9.6 - Room Kit Mini

• CE9.8 - Board 55/55S, Board 70/70S, and Board 85S

For more details, we recommend reading the Software release notes:

 https://www.cisco.com/c/en/us/support/collaboration-endpoints/telepresence-quick-set-series/ products-release-notes-list.html

xConfiguration xCommand xStatus

API Reference Guide

Appendices

New features and improvements in CE9.10

Webex Edge for Devices

(All products)

Devices running CE9.10 are ready for Webex Edge for

Devices . You can use Webex Edge for Devices to link your on-premises devices to the Cisco Webex cloud service.

This gives you access to select cloud features, while your registration, device management, calling, and media services remain on-premises. You can manage cloud services and get device diagnostics from them in Webex Control Hub.

You need the Device Connector tool to get started. Read the

Release Notes on Webex Help Center to find out when the tool is available.

Easier to join Webex meetings (All products)

We have added a Join Webex button in the user interface.

The button is shown by default.

The Join Webex button allows users to join meetings by entering the meeting number without a domain. This information is available in the Webex email invite. The infrastructure must allow calls to be routed to *@webex.com

New procedure for defining a password policy

(All products)

(

In earlier CE software versions, the password policy was defined using the systemtools securitysettings command.

This command has now been replaced by configurations xConfiguration UserManagement PasswordPolicy *

Some of the previous restrictions are discontinued.

When upgrading a device from an earlier CE software version, the values previously stored through the systemtools securitysettings command are preserved. The ones that are no longer reflected by configurations are deleted. The previous defaults were all 0, so on upgrade, if no changes had been made, the new defaults are also all 0.

SNMP is switched off by default (All products)

SNMP (Simple Network Management Protocol) is switched off by default. Also, we no longer provide a default community name.

When upgrading a device from an earlier CE software version, the values that were previously stored are preserved.

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xConfiguration changes in CE9.10

New configurations

Cameras SpeakerTrack Closeup

(Boards)

Macros UnresponsiveTimeout

(Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D,

Room 70, Room 70 G2, Boards, SX80, SX20, MX700, MX800, MX200 G2, MX300 G2, DX80, DX70)

Peripherals Pairing CiscoTouchPanels RemotePairing (Codec Pro, Codec Plus, Room Kit, Room Kit Mini,

Room 55, Room 55D, Room 70, Room 70 G2, Boards, SX80, SX20, SX10, MX700, MX800, MX200 G2, MX300 G2)

Provisioning WebexEdge (All products)

Security Fips Mode (All products)

UserInterface Features Call JoinWebex (All products)

UserManagement PasswordPolicy Complexity MinimumDigits (All products)

UserManagement PasswordPolicy Complexity MinimumLength (All products)

UserManagement PasswordPolicy Complexity MinimumLowercase

(All products)

UserManagement PasswordPolicy Complexity MinimumSpecial

(All products)

UserManagement PasswordPolicy Complexity MinimumUppercase (All products)

UserManagement PasswordPolicy MaxLifetime (All products)

UserManagement PasswordPolicy ReuseLimit (All products)

Configurations that are removed

None.

API Reference Guide

Appendices xCommand xStatus

Configurations that are modified

Cameras SpeakerTrack Closeup

(Codec Pro, Codec Plus, Room Kit, Room 55, Room 55D, Room 70,

Room 70 G2, SX80, MX700, MX800)

OLD: Auto/Off

NEW: Auto/Off/On

NetworkServices SMTP Security (Boards)

OLD: Default: None

NEW: Default: StartTls

NetworkServices SNMP Mode (All products)

OLD: Default: ReadOnly

NEW: Default: Off

Standby Signage Mode (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room 70,

Room 70 G2, Boards)

OLD: User role: ADMIN

NEW: User role: ADMIN, INTEGRATOR

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xCommand changes in CE9.10

New commands

Video CEC Output SendInactiveSourceRequest

(Codec Pro, Codec Plus, Room Kit, Room Kit Mini,

Room 55, Room 55D, Room 70, Room 70 G2)

Commands that are removed

Security FIPSMode Activate

(All products)

Replaced by the Security Fips Mode configuration.

Commands that are modified

UserInterface WebView Display (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D,

Room 70, Room 70 G2, Boards)

NEW: Header: String (0, 8192) [multiple 15]

UserManagement User Add (All products)

Removed: PinChangeRequired

UserManagement User Modify (All products)

Removed: PinChangeRequired xCommand xStatus

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xStatus changes in CE9.10

New statuses

None.

Statuses that are removed

None.

Statuses that are modified

Diagnostics Message [n] Type (All products)

Added to valuespace: ProvModeWebexAndWebexEdgeEnabled/

WebexAccountPlusWebexEdgeEnabled/WebexEdgeAccountPlusProvModeWebex/

WebexMustUpgradeCeSoftware/WebexShouldUpgradeCeSoftware xCommand xStatus

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API

What’s new in CE9.9

This section provides an overview of the new and changed device settings, and the new features and improvements in the Cisco Collaboration Endpoint software version 9.9 (CE9.9) compared to CE9.8.

The following Webex products are new in CE9:

• CE9.0 - Room Kit

• CE9.1 - Codec Plus, and Room 55

• CE9.2 - Room 70

• CE9.4 - Codec Pro, Room 70 G2, and Room 55 Dual

• CE9.6 - Room Kit Mini

• CE9.8 - Board 55/55S, Board 70/70S, and Board 85S

For more details, we recommend reading the Software release notes:

 https://www.cisco.com/c/en/us/support/collaboration-endpoints/telepresence-quick-set-series/ products-release-notes-list.html

xConfiguration xCommand xStatus

API Reference Guide

Appendices

New features and improvements in CE9.9

Updates to the UI Extensions editor

(All products)

The In-room control editor has been renamed to UI

Extensions editor to reflect the additional features that are available. You can launch the editor by going to Integration >

UI Extension Editor on the web interface. In addition, the editor’s UI has been updated.

For more information, see the Customization guide for CE9.9 at  https://www.cisco.com/go/in-room-control-docs

Web apps (Boards)

You can use the UI Extensions editor to create web apps. This way you can access apps such as Jira, Miro, Office 365, and

Google docs directly from a board.

Digital signage

(Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room

70, Room 70 G2, Boards)

Digital signage allows you to display custom content, such as company news, building maps, or emergency information, when the device is in half-wake mode.

Users can interact with the signage content only on Webex

Boards.

Fetch branding images and custom wallpaper from an external URL (All products)

You can use the xCommand UserInterface Branding Fetch

API command to download branding images or a custom wallpaper from an external URL.

Custom wallpaper is not available for Webex Boards.

Changes to the Network Settings menu

(All products)

The Network connection page on the device’s user interface has changed. First you see an overview of the current network set-up, then you can open the Ethernet or Wi-Fi settings if you want to change them. A few settings, which were not available from the GUI before, are now added.

Changes to the ultrasound settings (All products)

All products now has the same default value for the Audio

Ultrasound MaxVolume setting. Also the volume range is aligned between the different products. Product specific differences are handled internally and no longer reflected in the range of values and the default value. We have not made any changes to the sound level that is played out from a device.

TLS configuration changes (All products)

For security reasons we have made some changes to the TLS configuration on HTTPS client, syslog, and SIP connections:

• You must explicitly turn off certificate verification if you don’t want to perform a certificate check. By default, certificates are checked on all TLS connections.

• The minimum TLS version is increased from version 1.0 to 1.1 (exceptions for CUCM and SIP, which still allow version 1.0). Also note that the Webex cloud is using TLS version 1.2.

• You can configure certificate verification for provisioning, phone book, and other HTTP servers separately. The former NetworkServices HTTPS VerifyServerCertificate setting, which covered all these server types, are replaced by three settings: Provisioning TLSVerify ,

Phonebook Server [1] TlsVerify , and HTTPFeedback

TlsVerify .

• You can configure certificate verification for external logging (both audit logging and regular logging).

• For SIP, the certificates are verified against the Custom

CA list , which is uploaded to the device manually using the web interface or API. For other connections, the certificates are verified against either the Pre-installed CA list on the device, or the Custom CA list .

Cisco Collaboration Endpoint Software



Introduction About the API

Updates to whiteboarding and annotations

(Boards)

• Create, edit, and move stickies on your whiteboard and annotations.

• Choose between three different pen sizes when whiteboarding and annotating.

• Create copies of whiteboards and annotations. The whiteboard or annotated snapshot of a presentation is stored in the Whiteboard menu. You can go back to it and continue work on the copy as you would on any other whiteboard or snapshot.

Wired touch redirect (Boards)

Touch redirect enables you to control your laptop from a

Webex Board screen. You must connect the laptop to the

Webex Board with an HDMI cable (wired sharing) and a

USB-C cable.

Touch redirect only works outside of call.

This feature is only available on the second generation of boards (Webex Board 55S, 70S, and 85S).

xConfiguration xCommand xStatus

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xCommand xStatus

API Reference Guide

Appendices xConfiguration changes in CE9.9

New configurations

Audio Input ARC [1] Mode

(Codec Plus)

Audio Input HDMI [2..3] Level

(Room 55D, Room 70)

Audio Input HDMI [2..3] Mode (Room 55D, Room 70)

Audio Input HDMI [2..3] VideoAssociation MuteOnInactiveVideo (Room 55D, Room 70)

BYOD TouchForwarding Enabled (Boards)

Not available in CE9.9.0.

HttpFeedback TlsVerify (All products)

Logging External TlsVerify (All products)

Phonebook Server [1] TlsVerify (All products)

Provisioning TlsVerify (All products)

SIP MinimumTLSVersion (All products)

Standby Signage Audio (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room 70,

Room 70 G2, Boards)

Standby Signage InteractionMode (Boards)

Standby Signage Mode (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room 70,

Room 70 G2, Boards)

Standby Signage RefreshInterval (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D,

Room 70, Room 70 G2, Boards)

Standby Signage Url (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room 70, Room

70 G2, Boards)

WebEngine Mode (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room 70, Room 70

G2, Boards)

WebEngine RemoteDebugging (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room

70, Room 70 G2, Boards)

Configurations that are removed

NetworkServices HTTPS VerifyServerCertificate

(All products)

Replaced by:

• HttpFeedback TlsVerify

• Phonebook Server [1] TlsVerify

• Provisioning TlsVerify

Configurations that are modified

Audio Ultrasound MaxVolume

The valuespace and default value has changed for many products. Product specific differences are now handled internally and not reflected in the default value and range of possible values.

NEW: Integer (0..90)

(Codec Pro, Codec Plus, SX80, SX20)

NEW: Integer (0..70) (Room Kit, Room Kit Mini, Room 55, Room 55D, Room 70, Room 70 G2, Boards, SX10,

MX700, MX800, MX200 G2, MX300 G2, DX70, DX80)

NEW: Default value: 70 (All products)

SIP ListenPort (All products)

OLD: Off/On

NEW: Auto/Off/On

SIP ListenPort (Boards)

OLD: Default: On

NEW: Default: Auto

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xCommand changes in CE9.9

New commands

Logging SendLogs

(All products)

Security Certificates Webex Show

(All products)

UserInterface Branding Fetch (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room

70, Room 70 G2, Boards, SX80, SX20, MX700, MX800, MX200 G2, MX300 G2, DX70, DX80)

UserInterface WebView Clear (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room

70, Room 70 G2, Boards)

UserInterface WebView Display (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D,

Room 70, Room 70 G2, Boards)

WebEngine DeleteStorage (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room 70,

Room 70 G2, Boards)

Commands that are removed

Cameras AutoFocus Diagnostics Start (Room Kit, Room Kit Mini, Room 55, Boards)

Cameras AutoFocus Diagnostics Stop (Room Kit, Room Kit Mini, Room 55, Boards)

Commands that are modified

Audio Volume SetToDefault (Room Kit, Room Kit Mini, Room 55)

NEW: Device: Internal/HeadsetUSB/HandsetUSB

Camera PositionSet

(Codec Pro, Room 70 G2)

NEW: Roll: Integer (-300..300)

HttpClient Delete

(All products)

OLD: ResponseSizeLimit: Integer (0..100000)

NEW: ResponseSizeLimit: Integer (1..100000)

HttpClient Get (All products)

OLD: ResponseSizeLimit: Integer (0..100000)

NEW: ResponseSizeLimit: Integer (1..100000)

HttpClient Patch (All products)

OLD: ResponseSizeLimit: Integer (0..100000)

NEW: ResponseSizeLimit: Integer (1..100000) xCommand xStatus

HttpClient Post

(All products)

OLD: ResponseSizeLimit: Integer (0..100000)

NEW: ResponseSizeLimit: Integer (1..100000)

HttpClient Put (All products)

OLD: ResponseSizeLimit: Integer (0..100000)

NEW: ResponseSizeLimit: Integer (1..100000)

Phonebook Contact Add

(All products)

OLD: CallRate: Integer (0..6000), Default: 0

NEW: CallRate: Integer (0..6000), Default: none

Phonebook ContactMethod Add (All products)

OLD: CallRate: Integer (0..6000), Default: 0

NEW: CallRate: Integer (0..6000), Default: none

Phonebook ContactMethod Modify (All products)

OLD: CallRate: Integer (0..6000), Default: 0

NEW: CallRate: Integer (0..6000), Default: none

Standby ResetTimer (All products)

OLD: Delay: required parameter

NEW: Delay: optional parameter

UserInterface Extensions Clear (All products)

NEW: ActivityType: Custom/WebApp

UserInterface Extensions List (All products)

NEW: ActivityType: Custom/WebApp

D15407.13 Cisco Collaboration Endpoint Software API Reference Guide CE9.12, APRIL 2020 17

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xStatus changes in CE9.9

New statuses

Cameras Camera [n] Position Roll

(Codec Pro, Room 70 G2)

RoomAnalytics AmbientNoise Level A

(Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room

55D, Room 70, Room 70 G2, Boards)

Renamed from RoomAnalytics AmbientNoise Level dBA

RoomAnalytics Sound Level A (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room

70, Room 70 G2, Boards)

SystemUnit Hardware Monitoring Temperature Status (Codec Pro, Codec Plus, Room Kit, Room Kit Mini,

Room 55, Room 55D, Room 70, Room 70 G2, Boards)

WebEngine Features Signage

(Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room

70, Room 70 G2, Boards)

WebEngine Features WebEngine (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D,

Room 70, Room 70 G2, Boards)

Webex Status (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room 70, Room 70 G2,

Boards)

Statuses that are removed

RoomAnalytics AmbientNoise Level dBA (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room

55D, Room 70, Room 70 G2, Boards)

Renamed to RoomAnalytics AmbientNoise Level A

Statuses that are modified

Diagnostics Message [n] Type (All products)

Added to valuespace: CompanionModeIncompatibilityLocal/

CompanionModeIncompatibilityRemote/EmbeddedWebViewFailedToLoad/

EmbeddedWebViewTerminatedUnexpectedly/SoftwareUpgradeKeepsFailing xCommand xStatus

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API

What’s new in CE9.8

This section provides an overview of the new and changed device settings, and the new features and improvements in the Cisco Collaboration Endpoint software version 9.8 (CE9.8) compared to CE9.7.

For more details, we recommend reading the Software release notes:

 https://www.cisco.com/c/en/us/support/ collaboration-endpoints/telepresence-quick-setseries/products-release-notes-list.html

xConfiguration xCommand xStatus

API Reference Guide

Appendices

New features and improvements in CE9.8

New products

The Cisco Webex Boards, which previously have been available only for cloud registration, are now also available for on-premises registration:

• Cisco Webex Board 55/55S

• Cisco Webex Board 70/70S

• Cisco Webex Board 85S

Support for USB headsets

(Room Kit, Room Kit Mini, Room 55)

You can connect a USB Headset, Handset or USB Bluetooth dongle to the USB-A port on the devices. This is similar to the

DX series.

Extended support for HTTP requests (All products)

Since CE9.6 a device has been able to send arbitrary

HTTP(S) Post and Put requests to an HTTP(S) server. This feature is extended to support more request types (Get,

Patch, and Delete), and also to handle data that is returned from the server (response headers and body).

Improved USB-C experience (Room Kit Mini)

The Room Kit Mini is in USB camera mode only when it is streaming media to a computer over the USB-C port. In previous releases it was sufficient that at computer was connected to the USB-C port.

Add participant to CMS conference from the device UI

(All products)

Any user can add another participant to an ongoing CMS conference using the user interface of the device. This also includes PSTN calls. When the participant accepts the call, the participant will be added to the same CMS conference.

In this case the device will tell the CMS to dial the participant using the Active Control mechanism. Then the CMS will dial directly to the participant you want to add.

For this feature to work, Active Control must be enabled on the device, the call protocol must be SIP, and the CMS must be on version 2.4 or higher. The feature doesn’t work if multipoint mode is set to CUCMMediaResourceGroupList.

Interface

(All products)

You can register a device to Cisco Webex remotely, so you don’t have to be in the same room as the device. You can do this programmatically from the API or use the local web interface. In earlier releases you had to use the on-screen setup assistant.

From the web interface, you can only start Webex registering if the device is not currently registered anywhere. If you are using the API, you can start Webex registering even if the device is currently registered to an on-premise system

(CUCM or VCS).

Pre-installed list of Certificate Authorities - CAs (All products)

A list of commonly used CA certificates are pre-installed on the video conferencing device. The device uses this list when validating certificates from external servers that it communicates with:

• HTTP servers that host content used by the HttpClient

API or macros

• SMTP mail servers (only relevant for Webex Boards)

A factory reset does not delete the list.

xAPI over WebSocket: Authentication using auth protocol header (All products)

Authentication using an auth protocol header is supported.

This comes in addition to Basic authentication using an HTTP header field.

This means that browser-based clients, which don’t have direct control over HTTP headers, can authenticate to a device directly from the browser using Javascript.

Cisco Collaboration Endpoint Software



Introduction About the API

More device settings can be provisioned from UCM than before (All products)

If the device is registered to Cisco UCM 12.5(1)SU1 more settings and parameters can be provisioned from UCM than before ( Device > Product Specific Configuration Layout ). Also, if these settings are changed locally on the device, the new value can be written back to the UCM.

Most of the device’s public settings (xConfiguration), are included. Exceptions are made for Network, Provisioning and

SIP settings.

See the Video Endpoints Management Overview section in the



Release Notes for Cisco Unified ommunications

Manager and the IM and Presence Service, Release 12.5(1)

SU1 for more information.

xConfiguration xCommand xStatus

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration changes in CE9.8

New configurations

Conference FarEndControl SignalCapability

(All products)

Conference MicUnmuteOnDisconnect Mode

(All products)

Conference Multipoint Mode (SX10, DX70, DX80)

FacilityService Service [1..5] CallType (All products)

FacilityService Service [1..5] Name (All products)

FacilityService Service [1..5] Number (All products)

FacilityService Service [1..5] Type (All products)

NetworkServices SMTP From (Boards)

NetworkServices SMTP Mode (Boards)

NetworkServices SMTP Password (Boards)

NetworkServices SMTP Port

(Boards)

NetworkServices SMTP Security

(Boards)

NetworkServices SMTP Server (Boards)

NetworkServices SMTP Username (Boards)

Security Audit Logging Mode (All products)

Security Audit OnError Action (All products)

Security Audit Server Address (All products)

Security Audit Server Port (All products)

Security Audit Server PortAssignment (All products)

Security Session FailedLoginsLockoutTime (All products)

Security Session InactivityTimeout

(All products)

Security Session MaxFailedLogins

(All products)

Security Session MaxSessionsPerUser

(All products)

Security Session MaxTotalSessions (All products)

Security Session ShowLastLogon (All products)

SerialPort LoginRequired (Codec Pro, Room 70 G2)

D15407.13 Cisco Collaboration Endpoint Software API Reference Guide CE9.12, APRIL 2020 xConfiguration

API Reference Guide

Appendices xCommand xStatus

UserInterface OSD EncryptionIndicator

(All products)

UserInterface Phonebook DefaultSearchFilter

(All products)

UserInterface SoundEffects Mode (All products)

Configurations that are removed

Video DefaultLayoutFamily Remote (SX10, DX70, DX80)

Configurations that are modified

Audio KeyClickDetector Attenuate

(Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D,

Room 70, Room 70 G2)

OLD: Default: On

NEW: Default: True

OLD: Off/On

NEW: False/True

Audio KeyClickDetector Enabled (Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D,

Room 70, Room 70 G2)

OLD: Default: Off

NEW: Default: True

OLD: Off/On

NEW: False/True

Audio Output Line [1..6] Delay Mode (Room 70 G2)

OLD: Default: RelativeToHDMI

NEW: Default: Fixed

NetworkServices Wifi Allowed

(Codec Pro, Codec Plus, Room Kit, Room Kit Mini, Room 55, Room 55D, Room

70, Room 70 G2, DX70, DX80)

OLD: Public: False

NEW: Public: True

Cisco Collaboration Endpoint Software



Introduction About the API xCommand changes in CE9.8

New commands

Audio Select

(Room Kit, Room Kit Mini, Room 55)

HttpClient Delete

(All Products)

HttpClient Get (All Products)

HttpClient Patch (All Products)

Security Certificates ThirdParty Disable (All Products)

Security Certificates ThirdParty Enable (All Products)

Security Certificates ThirdParty List (All Products)

Security Certificates ThirdParty Show (All Products)

Webex Registration Cancel (All Products)

Webex Registration Start (All Products)

Commands that are removed

None.

xConfiguration xCommand xStatus

Commands that are modified

Audio Volume Decrease

(Room Kit, Room Kit Mini, Room 55)

NEW: Device: Internal/HeadsetUSB/HandsetUSB

NEW: Steps: Integer (1..10), Default: 5

Audio Volume Increase (Room Kit, Room Kit Mini, Room 55)

NEW: Device: Internal/HeadsetUSB/HandsetUSB

NEW: Steps: Integer (1..100)

Audio Volume Set (Room Kit, Room Kit Mini, Room 55)

NEW: Device: Internal/HeadsetUSB/HandsetUSB

NEW: Steps: Integer (1..1000), Default: 100

Audio VuMeter Start (All Products)

NEW: IntervalMs: Integer (10..1000), Default:100

HttpClient Post (All Products)

NEW: ResponseSizeLimit: Integer (0..100000), Default: 100000

NEW: ResultBody: None/PlainText/Base64, Default: None

HttpClient Put (All Products)

NEW: ResponseSizeLimit: Integer (0..100000), Default: 100000

NEW: ResultBody: None/PlainText/Base64, Default: None

Presentation Start (Room Kit Mini)

OLD: ConnectorId: Integer (0..65534)

NEW: ConnectorId: Integer (1..2)

OLD: PresentationSource: Integer (0..65534)

NEW: PresentationSource: Integer (1..2)

Presentation Stop

(Room Kit Mini)

OLD: PresentationSource: Integer (0..65534)

NEW: PresentationSource: Integer (1..2)

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xStatus changes in CE9.8

New statuses

Audio Devices HandsetUSB ConnectionStatus

(Room Kit, Room Kit Mini, Room 55)

Audio Devices HandsetUSB Cradle

(Room Kit, Room Kit Mini, Room 55)

Audio Devices HeadsetUSB ConnectionStatus (Room Kit, Room Kit Mini, Room 55)

Audio Devices HeadsetUSB Description (Room Kit, Room Kit Mini, Room 55)

Audio Devices HeadsetUSB Manufacturer (Room Kit, Room Kit Mini, Room 55)

Audio SelectedDevice (Room Kit, Room Kit Mini, Room 55)

Audio VolumeHandsetUsb (Room Kit, Room Kit Mini, Room 55)

Audio VolumeHeadsetUsb (Room Kit, Room Kit Mini, Room 55)

Audio VolumeInternal (Room Kit, Room Kit Mini, Room 55)

Cameras Camera [n] LightingConditions (MX700, MX800, SX80)

Conference Call [n] Capabilities ParticipantDisconnect

(All Products)

Conference Call [n] Capabilities ParticipantList

(All Products)

Conference Call [n] Capabilities ParticipantMute (All Products)

Conference Call [n] EventCenter Mode (All Products)

Conference Call [n] Streamed (All Products)

UserInterface Features Whiteboard Start (Codec Plus, Codec Pro, Room Kit, Room Kit Mini)

Statuses that are removed

None.

API Reference Guide

Appendices xCommand xStatus

Statuses that are modified

Audio Input KeyClick Attenuate

(Codec Plus, Codec Pro, Room Kit, Room Kit Mini, Room 55, Room 55 Dual,

Room 70, Room 70 G2)

OLD: On/Off

NEW: False/True

Audio Input KeyClick Enabled (Codec Plus, Codec Pro, Room Kit, Room Kit Mini, Room 55, Room 55 Dual,

Room 70, Room 70 G2)

OLD: On/Off

NEW: False/True

Diagnostics Message[n] Type (All Products)

Added to valuespace: SignageFailedToLoad/SignageTerminatedUnexpectedly

SystemUnit Notifications Notification [n] Type (All Products)

OLD: FactoryResetFailed/FactoryResetOK/Other/RebootRequired/SoftwareUpgradeFailed/

SoftwareUpgradeOK

NEW: Other/RebootRequired/SoftwareUpgradeFailed/SoftwareUpgradeOK

Cisco Collaboration Endpoint Software



Introduction About the API

What’s new in CE9.7

This section provides an overview of the new and changed device settings, and the new features and improvements in the Cisco Collaboration Endpoint software version 9.7 (CE9.7) compared to CE9.6.

For more details, we recommend reading the Software release notes:

 https://www.cisco.com/c/en/us/support/collaboration-endpoints/telepresence-quick-set-series/ products-release-notes-list.html

xConfiguration xCommand xStatus

API Reference Guide

Appendices

New features and improvements in CE9.7

Connect to xAPI over a WebSocket

(All products)

You can now connect to the xAPI over WebSocket. The communication channel over WebSocket is open both ways until it is explicitly closed. This means that the server can send data to the client as soon as the new data is available, and there is no need for re-authentication for every request.

This improves speed significantly compared to HTTP.

Each message contains a complete JSON document and nothing else. Many programming languages have good library support for WebSocket and JSON-RPC.

WebSocket is not enabled by default. Note that WebSocket is tied to HTTP and HTTP or HTTPS must be enabled before you can use WebSocket.

For more information, see  xAPI over WebSocket guide.

Graphical sound mixer available on Audio Console

(Codec Pro, MX700, MX800, Room 70 G2, Room 70D G2, SX80)

The Audio Console now has a graphical sound mixer. It has

8 user-definable parametric equalizer settings. A setting consists of up to 6 sections, each of which has its own filter type, gain, center/crossover frequency and Q value. Each section is shown with its own color and the effect of altering any of the parameters immediately becomes visible in the graph.

For more information, see the Customization guide for CE9.7 at  https://www.cisco.com/go/in-room-control-docs

Ambient noise reporting

(Codec Plus, Codec Pro, Room 55, Room 55 Dual, Room 70, Room 70 G2, Room

Kit, Room Kit Mini)

The Room series devices can be configured to report the stationary ambient noise level in the room. The reported value is an A-weighted decibel value (dBA), which reflects the response of the human ear. Based on reported noise, facility management or a building manager can intervene to troubleshoot the issue.

All signal processing related to this feature is local and the only data transmitted is the calculated noise level.

Support for multiple SRG-120DH/PTZ-12 cameras

(Codec Plus)

You can now connect up to three SRG-120DH/PTZ-12 cameras to a Codec Plus using an HDMI and an Ethernet switch.

Other updates

• 1080p support for Room Kit Mini when it is used as a USB camera. (Room Kit Mini)

• You can turn video off and on during calls.

(All products)

• A device administrator can prevent the use of HTTP and only allow HTTPS Post and HTTPS Put requests.

(All products)

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xConfiguration changes in CE9.7

New configurations

CallHistory Mode

(All products)

Conference Multipoint Mode

(Codec Pro, Codec Plus, MX200 G2, MX300 G2, MX700, MX800, Room Kit,

Room Kit Mini, Room 55, Room 55D, Room 70, Room 70 G2, SX20, SX80)

HttpClient AllowHTTP (All products)

Logging External Mode (All products)

Logging External Protocol

(All products)

Logging External Server Address

(All products)

Logging External Server Port (All products)

Logging Internal Mode (All products)

NetworkServices Websocket (All products)

Phonebook Server [1] Pagination (All products)

RoomAnalytics AmbientNoiseEstimation Mode (Codec Plus, Codec Pro, Room Kit, Room Kit Mini, Room

55, Room 55D, Room 70, Room 70 G2)

SIP ANAT (All products)

UserInterface Features Call VideoMute (Codec Plus, Codec Pro, MX200 G2, MX300 G2, MX700, MX800,

Room Kit, Room Kit Mini, Room 55, Room 55D, Room 70, Room 70 G2, SX10, SX20, SX80)

UserInterface Features Whiteboard Start

(DX70, DX80)

UserInterface Phonebook Mode (All products)

UserInterface SettingsMenu Visibility (All products)

UserInterface UsbPromotion (Room Kit Mini)

Video Presentation Priority (All products)

Configurations that are removed

RoomAnalytics PeopleCountOutOfCall (MX700, MX800)

API Reference Guide

Appendices xCommand xStatus

Configurations that are modified

Audio Input Line [1..4] VideoAssociation VideoInputSource

(MX700, MX800, SX80)

OLD: 1/2/3/4/5

NEW: 1/2/3/4

Audio Input Microphone [1..8] VideoAssociation VideoInputSource (Codec Pro, Room 70 G2)

OLD: 1/2/3/4/5

NEW: 1/2/3/4/5/6

Audio Input Microphone [1..8] VideoAssociation VideoInputSource (MX700, MX800, SX80)

OLD: 1/2/3/4/5

NEW: 1/2/3/4

Video Input Connector [6] CameraControl Mode (Codec Pro, Room 70 G2)

OLD: Default: On

NEW: Default: Off

OLD: On

NEW: On/Off

Cisco Collaboration Endpoint Software



Introduction About the API xCommand changes in CE9.7

New commands

Audio Diagnostics Advanced Run

(All products)

Audio Setup Reset

(Codec Pro, MX700, M800, Room 70 G2, SX80)

Conference Call AuthenticationResponse (All products)

Conference Participant Admit (All products)

Conference Participant Disconnect (All products)

Conference Participant Mute (All products)

Conference ParticipantList Search (All products)

UserInterface Extensions Panel Open (All products)

UserInterface Extensions Panel Update (All products)

Video Input MainVideo Mute (All products)

Video Input MainVideo Unmute

(All products)

Video Matrix Assign

(Room 55D, Room 70)

Video Matrix Reset (Room 55D, Room 70)

Video Matrix Swap (Room 55D, Room 70)

Video Matrix Unassign (Room 55D, Room 70)

Commands that are removed

None.

xConfiguration xCommand xStatus

Commands that are modified

Audio LocalOutput Add

(Codec Pro, MX700, M800, Room 70 G2, SX80)

NEW: AutoconnectRemote: On/Off, Default: On

OLD: VolumeControlled, Default: none

NEW: VolumeControlled, Default: Off

Audio LocalOutput Update (Codec Pro, MX700, M800, Room 70 G2, SX80)

NEW: AutoconnectRemote: On/Off

CallHistory Get (All products)

OLD: CallHistoryId: Integer (0..65534)

NEW: CallHistoryId: Integer (1..2147483647)

HttpClient Post (All products)

NEW: Timeout: Integer (1..30), Default: 30

HttpClient Put (All products)

NEW: Timeout: Integer (1..30), Default: 30

UserInterface Message TextInput Display (All products)

NEW: InputText: String (0, 255), Default: ““

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xStatus changes in CE9.7

New statuses

Audio Output LocalOutput [n] AutoconnectRemote

(Codec Pro, MX700, MX800, Room 70 G2, SX80)

Call [n] Ice

(All products)

Conference Call [n] AuthenticationRequest (All products)

NetworkServices UPnP Status (All products)

Peripherals ConnectedDevice [n] SerialNumber (All products)

Provisioning CUCM Customization Checksum (All products)

RoomAnalytics AmbientNoise Level dBA (Codec Plus, Codec Pro, Room Kit, Room Kit Mini, Room 55, Room

55D, Room 70, Room 70 G2)

UserInterface Features Whiteboard Start (DX70, DX80)

UserInterface SettingsMenu Visibility (All products)

Video Input MainVideoMute (All products)

Statuses that are removed

None.

Statuses that are modified

Diagnostics Message [n] Type (All products)

Added to valuespace: PIILoggingMode/WebexAudioProximityConnectivity/

WebexLyraConnectivity/WebexNotificationConnectivity

Video Input Connector[n] Type (All products)

OLD: 3G-SDI/Camera/Composite/DVI/HD-SDI/HDMI/USB/Unknown/VGA/YC/YPbPr

NEW: 3G-SDI/Camera/Composite/DVI/HD-SDI/HDMI/USB/Unknown/VGA/YC/YPbPr/

USBC-DP xCommand xStatus

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API

What’s new in CE9.6

This section provides an overview of the new and changed device settings, and the new features and improvements in the Cisco Collaboration Endpoint software version 9.6 (CE9.6) compared to CE9.5.

For more details, we recommend reading the Software release notes:

 https://www.cisco.com/c/en/us/support/collaboration-endpoints/telepresence-quick-set-series/ products-release-notes-list.html

xConfiguration xCommand xStatus

API Reference Guide

Appendices

New features and improvements

HDCP support

(Codec Plus, Codec Pro, Room 55 Dual, Room 70, Room 70 G2)

One of the device’s HDMI inputs can be configured to support

HDCP (High-bandwidth Digital Content Protection) protected content. This allows customers to re-purpose the screen by connecting other devices such as a Google Chromecast, an

Apple TV, or an HDTV decoder. This type of content cannot be shared while in a call.

When the connector is configured to support HDCP, it is reserved for this type of content. This means that you cannot share any content from this specific connector while in a call, not even non-protected content from a laptop.

Remove default buttons from the user interface

(All products)

If you don’t need all of the default buttons on the user interface, you can remove the ones that you don’t need. This makes it possible to fully customize the user interface. The configuration only removes the buttons, not the functionality as such, and the custom In-Room Control panels can still be exposed.

For more information, see the Cusomization guide for CE9.6 at

 https://www.cisco.com/go/in-room-control-docs

Support for third-party USB controllers

(Codec Plus, Codec Pro, DX70, DX80, Room 55, Room 55 Dual, Room 70, Room

70 G2, Room Kit)

You can use a third-party USB input device to control certain functions on a room device. A Bluetooth remote control with a

USB dongle and a USB keyboard are examples of such input devices. You can setup the desired features through macros.

This feature is meant to complement the functionality of the

Touch 10 or the DX user interfaces. It is not meant to replace the Touch 10 and DX user interfaces.

For more information, see the Cusomization guide for CE9.6 at  https://www.cisco.com/go/in-room-control-docs

HTTP Post and Put requests

(All products)

This feature makes it possible to send arbitrary HTTP(S) Post and Put requests from a device to an HTTP(S) server.

By using macros, you can send data to an HTTP(S) server whenever you want. You can choose what data to send, and structure them as you like. This way you can adapt the data to an already established service.

Security measures:

• The HTTP(S) Post/Put feature is disabled by default.

• The device administrator can specify a list of HTTP(S) servers that the device is allowed to send data to.

• The number of concurrent Post and Put requests is limited.

Content priority

(All products)

You can now configure your device to prioritize bandwidth usage for either Main Video Channel or Presentation Channel. xConfiguration Video Presentation Priority: <Equal,

High>

Equal is the default configuration and means 50 / 50 bandwidth division. Selecting “High” divides the bandwidth

25 / 75 in favor of the presentation channel.

Other updates (All products)

• You can start and control recording meetings from the device’s user interface, provided that recording is supported by your infrastructure.

• Edit favorite contact’s information on Touch 10 controller.

• SIP calls now display the SIP Session ID field in the logs to help identify calls.

• Ability to use ICE over MRA to locate the best path for media.

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xConfiguration changes in CE9.6

New configurations

Audio Input Microphone [1..8] Channel

(Codec Pro, Room 70 G2)

Audio Input HDMI [n] Level

(Codec Plus, Room 55, Room 70 G2, Room Kit)

Audio Input HDMI [n] Mode (Room 70 G2, Room Kit)

Audio Input HDMI [2..5] VideoAssociation MuteOnInactiveVideo (Room 70 G2)

Audio Microphones PhantomPower (Codec Plus, MX200 G2, MX300 G2, Room 55, Room Kit, SX20)

Audio Output ConnectorSetup (Codec Pro, Room 70 G2)

Audio Output HDMI [n] Level (MX700, MX800)

Audio Output HDMI [n] Mode (Codec Plus, MX700, MX800)

Audio Output InternalSpeaker Mode (MX700, MX800, Room 55 Dual, Room 70)

Audio Output Line [1..6] Equalizer ID (Room 70 G2)

Audio Output Line [1..6] Equalizer Mode

(Room 70 G2)

HttpClient AllowInsecureHTTPS

(All products)

HttpClient Mode (All products)

NetworkServices NTP Server [1..3] Key (All products)

NetworkServices NTP Server [1..3] KeyId (All products)

NetworkServices NTP Server [1..3] KeyAlgorithm (All products)

Peripherals InputDevice Mode (Codec Plus, Codec Pro, DX70, DX80, Room 55, Room 55 Dual, Room 70,

Room 70 G2, Room Kit)

UserInterface Branding AwakeBranding Colors (All products)

UserInterface Features Call End (All products)

UserInterface Features Call MidCallControls (All products)

UserInterface Features Call Start (All products)

UserInterface Features HideAll (All products)

UserInterface Features Share Start (All products)

Video Input Connector [n] HDCP Mode (Codec Plus, Codec Pro, Room 55 Dual, Room 70, Room 70 G2)

Video Output Connector [2] CEC Mode

(Room 70 Single) xCommand xStatus

Configurations that are removed

Conference MultiStream Mode

(MX200 G2, MX300 G2, SX20)

Configurations that are modified

Audio Output ARC [1] Mode (Codec Pro, Room 70 G2)

OLD: Default: Auto

NEW: Default: On

OLD: Off/On/Auto

NEW: Off/On

Audio Output HDMI [1..3] Mode (Codec Pro, Room 70 G2)

OLD: Default: Auto (Codec Pro)

NEW: Default: On

(Codec Pro)

OLD: Default, HDMI [2..3]: Auto (Room 70 G2 Single)

NEW: Default, HDMI [2..3]: Off (Room 70 G2 Single)

OLDl: Default, HDMI [3]: Auto (Room 70 G2 Dual)

NEW: Default, HDMI [3]: Off

(Room 70 G2 Dual)

OLD: Off/On/Auto

NEW: Off/On

Audio Output InternalSpeaker Mode (Room 55, Room 70 G2, Room Kit)

OLD: Default: Auto (Room 70 G2)

NEW: Default: On (Room 70 G2)

OLD: Off/On/Auto (Room 70 G2)

NEW: Off/On/UltrasoundOnly (Room 70 G2)

OLD: Off/On (Room 55, Room Kit)

NEW: Off/On/UltrasoundOnly (Room 55, Room Kit)

Audio Ultrasound MaxVolume (SX20)

OLD: Default: 70

NEW: Default: 60

Provisioning Mode (All products)

OLD: Auto/CUCM/Edge/Off/TMS/VCS/Spark

NEW: Auto/CUCM/Edge/Off/TMS/VCS/Webex

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API

Provisioning Mode

(Room 55 Dual)

OLD: Default: Off

NEW: Default: On

Standby WakeupOnMotionDetection (Room 55 Dual)

OLD: Default: Off

NEW: Default: On xConfiguration xCommand xStatus

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xCommand changes in CE9.6

New commands

Conference Recording Pause

(All products)

Conference Recording Resume

(All products)

Conference Recording Start (All products)

Conference Recording Stop (All products)

HttpClient Allow Hostname Add (All products)

HttpClient Allow Hostname Clear (All products)

HttpClient Allow Hostname List (All products)

HttpClient Allow Hostname Remove (All products)

HttpClient Post (All products)

HttpClient Put (All products)

Security Session Get

(All products)

Commands that are removed

None.

Commands that are modified

Audio Sound Play (All products)

OLD: Sound: Alert/Binding/Bump/Busy/CallDisconnect/CallInitiate/CallWaiting/Dial/KeyInput/

KeyInputDelete/KeyTone/Nav/NavBack/Notification/OK/Pairing/PresentationConnect/

Ringing/SignIn/SpecialInfo/StartListening/TelephoneCall/VideoCall/VolumeAdjust/WakeUp

NEW: Sound: Alert/Binding/Bump/Busy/CallDisconnect/CallInitiate/CallWaiting/

Dial/KeyInput/KeyInputDelete/KeyTone/Nav/NavBack/Notification/OK/Pairing/

PresentationConnect/Ringing/SignIn/SpecialInfo/StartListening/TelephoneCall/VideoCall/

VolumeAdjust/WakeUp/Announcement

Audio VuMeter Start (DX70, DX80, Codec Plus, Codec Pro, Room 50, Room 70, Room 70 G2, Room Kit, SX10)

OLD: ConnectorType: HDMI/Microphone/Line

NEW: ConnectorType: HDMI/Microphone xCommand xStatus

API Reference Guide

Appendices

Audio VuMeter Stop

(DX70, DX80, Codec Plus, Codec Pro, Room 50, Room 70, Room 70 G2, Room Kit, SX10)

OLD: ConnectorType: HDMI/Microphone/Line

NEW: ConnectorType: HDMI/Microphone

Dial (All products)

OLD: CallType: Audio/Video

NEW: CallType: Audio/Video/Auto

Phonebook Contact Add

(All products)

OLD: CallType: Audio/Video

NEW: CallType: Audio/Video/Auto

Phonebook ContactMethod Add (All products)

OLD: CallType: Audio/Video

NEW: CallType: Audio/Video/Auto

Phonebook ContactMethod Modify (All products)

OLD: CallType: Audio/Video

NEW: CallType: Audio/Video/Auto

Phonebook Search (All products)

NEW: SearchFilter: All/Rooms/People

Presentation Start (All products)

NEW: Layout: Equal/Prominent

SystemUnit FactoryReset (All products)

OLD: Keep: Certificates/HTTP/LocalSetup/Network/Provisioning/SerialPort/Spark

NEW: Keep: Certificates/HTTP/LocalSetup/Network/Provisioning/SerialPort/Webex

UserInterface Message TextInput Clear (All products)

NEW: FeedbackId: String (0, 255)

UserInterface Message TextInput Display

(All products)

OLD: User role: Admin, Integrator, RoomControl, User

NEW: User role: Admin, Integrator, RoomControl

OLD: FeedbackId: required paramter

NEW: FeedbackId: optional parameter

UserInterface Message TextInput Response

(All products)

OLD: FeedbackId: required paramter

NEW: FeedbackId: optional parameter

Cisco Collaboration Endpoint Software



Introduction About the API

UserManagement User Add

(All products)

OLD: Passphrase: optional paramter

NEW: Passphrase: required paramter

Video Input SetMainVideoSource (All products)

OLD: Layout: Equal/PIP

NEW: Layout: Equal/PIP/Prominent

NEW: PIPPosition: LowerLeft/LowerRight/UpperLeft/UpperRight

NEW: PIPSize: Auto/Large

Video Matrix Assign (All products)

NEW: Layout: Equal/Prominent

NEW: RemoteMain: Integer (1..4)

Video Matrix Unassign (All products)

OLD: SourceId: required paramter

NEW: SourceId: optional paramter

NEW: RemoteMain: Integer (1..4) xConfiguration xCommand xStatus

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xStatus changes in CE9.6

New statuses

Audio Input Connectors HDMI [n] Mute

(All products)

Audio Input Connectors Line [n] Mute

(All products)

Audio Input Connectors Microphone [n] Mute (All products)

H320 Gateway Address (All products)

H320 Gateway Id (All products)

H320 Gateway Mode (All products)

H320 Gateway Number (All products)

H320 Gateway Reason (All products)

H320 Gateway Status (All products)

MediaChannels Call [n] Channel [n] Audio ChannelRole (All products)

UserInterface Features Call End

(All products)

UserInterface Features Call MidCallControls

(All products)

UserInterface Features Call Start (All products)

UserInterface Features Share Start (All products)

Video Layout Site [n] Frame [n] Mirrored (All products)

Statuses that are removed

Audio Output Connectors InternalSpeaker [n] DelayMs (Room 55 Dual, Room 70, Room 70 G2)

Audio Output Connectors InternalSpeaker [n] Mode (Room 55 Dual, Room 70, Room 70 G2)

Video Mute

(All products)

Statuses that are modified

Audio Output Connectors HDMI [n] Mode (Codec Plus, Codec Pro, Room 55 Dual, Room 70, Room 70 G2,

Room Kit)

OLD: Off/On

NEW: Off/On/DelayMeasurement xCommand

D15407.13 Cisco Collaboration Endpoint Software API Reference Guide CE9.12, APRIL 2020 33 xStatus

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API

What’s new in CE9.5

This section provides an overview of the new and changed device settings, and the new features and improvements in the Cisco Collaboration Endpoint software version 9.5 (CE9.5) compared to CE9.4.

For more details, we recommend reading the Software release notes:

 https://www.cisco.com/c/en/us/support/collaboration-endpoints/telepresence-quick-set-series/ products-release-notes-list.html

xConfiguration xCommand xStatus

API Reference Guide

Appendices

New features and improvements

Presentation source compositing

(Codec Plus, Codec Pro, MX200 G2, MX300 G2, MX700, MX800, Room 55,

Room 55 Dual, Room 70, Room 70 G2, Room Kit, SX20, SX80)

With using two or more content sources and sending them as one image, you can create a new experience for sharing in meetings

This gives users more flexibility with what they present to remote sites. You can configure the presentation composition through In-Room Controls together with Macros or an external controller.

The number of sources is determined by the device in use:

• MX200 G2, MX300 G2, Room Kit and SX20: up to two sources

• Room 55, Room 55 Dual, Room 70, Room Kit Plus: up to three sources

• MX700, MX800, Room 70 G2, Room Kit Pro, and SX80: up to four sources

You can only compose content that has been shared through a VGA or HDMI cable.

Web audio console (Codec Pro, SX80)

The new audio console is natively available on the web interface of the high-end integrator devices. The audio console gives you simplified tools to route audio from an input to an output. The new audio console replaces the old java-based

CE Console that is no longer maintained.

When you access the audio console for the first time you will see the default device audio routes. The audio console is controlled by an underlying macro which is saved and started once you select Choose to overwrite the current device configurations.

For more information, see the Cusomization guide for CE9.5 at  https://www.cisco.com/go/in-room-control-docs

Classroom scenario

(Codec Plus, Codec Pro, Room 55 Dual, Room 70, Room 70 G2, SX80)

The Classroom mode uses macros to tailor a room setup that works well for presenting and teaching scenarios. The template provides easy setup, maintenance, and use of the room. Classroom works similarly to the existing Briefing Room mode but it doesn’t require three screens.

Support for Korean keyboard (All products)

Korean keyboard input is now supported on Touch 10 controller when the user interface language is set to Korean.

Remote monitoring of screen status (SX20, SX80)

The remote monitoring of screen status that has been available for the Webex Room series and SX10 is now available for SX20 and SX80.

The video conferencing device can wake up the screen if it is in standby mode or put the screen to standby when the device enters standby. The input source can also be changed automatically when a call is received.

CEC is disabled on the device by default and must be enabled in the Video Output Connector [1] CEC Mode setting.

Your screen must support CEC and it has to be enabled on it for remote monitoring to work.

Welcome banner (All products)

You can set up a welcome banner that the user sees after they sign in to the device’s web interface or the command line interface. The banner can for example contain information that the user needs to get started or things they need to be aware of when changing settings.

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xConfiguration changes in CE9.5

New configurations

Audio Input ARC [n] Mode

(Codec Pro, Room 70 G2)

Audio Output ARC [1] Delay DelayMs

(Codec Pro, Room 70 G2)

Audio Output ARC [1] Delay Mode (Codec Pro, Room 70 G2)

Audio Output ARC [1] Mode (Codec Pro, Room 70 G2)

Audio Output InternalSpeaker Mode (Room 70 G2)

Audio Output Line [1] Mode (Codec Plus, Room 55)

Audio Output Line [1] OutputType (Codec Plus, Room 55)

NetworkServices SSH HostKeyAlgorithm (All products)

RoomAnalytics PeopleCountOutOfCall (SX80, MX700ST)

Configurations that are removed

Audio Output InternalSpeaker Mode (Codec Pro)

Cameras SpeakerTrack ConnectorDetection CameraLeft (Codec Pro, Room 70 G2)

Cameras SpeakerTrack ConnectorDetection CameraRight (Codec Pro, Room 70 G2)

Cameras SpeakerTrack ConnectorDetection Mode (Codec Pro, Room 70 G2)

Cameras SpeakerTrack TrackingMode (Codec Pro, Room 70 G2)

API Reference Guide

Appendices xCommand xStatus

Configurations that are modified

Audio Input Microphone [1..8] Equalizer ID

(Codec Pro, Room 70 G2)

OLD: Integer (1..14)

NEW: Integer (1..8)

Audio Ultrasound MaxVolume

(Codec Pro, MX700 with dual camera, Room 70 G2, SX80)

OLD: Default: 70 (Codec Pro, Room 70 G2, SX80)

NEW: Default: 60 (Codec Pro, Room 70 G2, SX80)

OLD: Default: 70 (MX700 with dual camera)

NEW: Default: 66

(MX700 with dual camera)

OLD: Integer: 0 – 90 (Room 70 G2)

NEW: Integer: 0 – 80 (Room 70 G2)

Video Input Connector[3,4,5] PreferredResolution (Codec Pro, Room 70 G2)

OLD: Default: 3840_2160_30

NEW: Default: 1920_1080_60

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xCommand changes in CE9.5

New commands

Audio Equalizer List

(SX80, Codec Pro, MX700, MX800, Room 70 G2)

Audio Equalizer Update

(SX80, Codec Pro, MX700, MX800, Room 70 G2)

Provisioning RoomType Activate (Codec Plus, Room 70)

SystemUnit WelcomeBanner Clear (All products)

SystemUnit WelcomeBanner Get (All products)

SystemUnit WelcomeBanner Set (All products)

UserInterface Extensions Panel Close (All products)

UserInterface Message TextInput Response (SX20, SX80, MX200 G2, MX300 G2, MX700, MX800)

UserManagement User Unblock (All Products)

Video CEC Output KeyClick (SX20, SX80, MX200 G2, MX300 G2, MX700, MX800)

Video CEC Output SendActiveSourceRequest

(SX20, SX80, MX200 G2, MX300 G2, MX700, MX800)

Commands that are removed

None.

Commands that are modified

Audio LocalInput AddConnector (Codec Pro, Room 70 G2)

OLD: ConnectorType: HDMI/Microphone/Line

NEW: ConnectorType: HDMI/Microphone/ARC

Audio LocalInput RemoveConnector (Codec Pro, Room 70 G2)

OLD: ConnectorType: HDMI/Microphone/Line

NEW: ConnectorType: HDMI/Microphone/ARC

Audio LocalOutput AddConnector

(Codec Pro, Room 70 G2

OLD: ConnectorType: HDMI/Microphone

NEW: ConnectorType: HDMI/Microphone/ARC

Audio LocalOutput RemoveConnector (Codec Pro, Room 70 G2)

OLD: ConnectorType: HDMI/Microphone

NEW: ConnectorType: HDMI/Microphone/ARC

API Reference Guide

Appendices xCommand xStatus

Audio Sound Play

(All products)

OLD: Sound: Alert/Bump/Busy/CallDisconnect/CallInitiate/CallWaiting/Dial/KeyInput/

KeyInputDelete/KeyTone/Nav/NavBack/Notification/OK/Pairing/PresentationConnect/

Ringing/SignIn/SpecialInfo/StartListening/TelephoneCall/VideoCall/VolumeAdjust/WakeUp

NEW: Sound: Alert/Bump/Busy/CallDisconnect/CallInitiate/CallWaiting/Dial/KeyInput/

KeyInputDelete/KeyTone/Nav/NavBack/Notification/OK/Pairing/PresentationConnect/

Ringing/SignIn/SpecialInfo/StartListening/TelephoneCall/VideoCall/VolumeAdjust/WakeUp/

Binding

Phonebook Search (SX80, Codec Plus, Codec Pro, Room Kit NOTE: Only when registered to Cisco Webex)

NEW: SearchFilter: All/Rooms/People

UserManagement User Modify (All products)

Removed: Unblock: False/True

Video Matrix Assign (SX20, SX80, Codec Plus, Codec Pro, Room Kit, MX200 G2, MX300 G2, MX700, MX800,

Room 70 G2)

OLD: SourceId: required parameter

NEW: SourceId: optional parameter

Video Matrix Unassign (SX20, Codec Plus, Room Kit, MX200 G2, MX300 G2)

OLD: SourceId: Integer (1..4) (Codec Plus)

NEW: SourceId: Integer (1..3)

(Codec Plus)

OLD: SourceId: Integer (1..4) (Room Kit, MX200 G2, MX300 G2)

NEW: SourceId: Integer (1..2) (Room Kit, MX200 G2, MX300 G2)

OLD: SourceId: Integer (1..3) (SX20)

NEW: SourceId: Integer (1..2) (SX20)

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xStatus changes in CE9.5

New statuses

Audio Input Connectors ARC [n] EcReferenceDelay

(All products)

Audio Output Connectors ARC [n] DelayMs

(Codec Plus, Codec Pro, Room 70, Room 70 G2)

Audio Output Connectors ARC [n] Mode (Codec Plus, Codec Pro, Room 70, Room 70 G2)

Provisioning RoomType (Codec Plus, Room 70)

SystemUnit Software OptionKeys MultiSite (SX10, DX70, DX80)

Video Mute (All products)

Video Output Monitor [n] FirmwareVersion (SX20, SX80, MX200 G2, MX300 G2, MX700, MX800)

Video Output Monitor [n] ModelName (SX20, SX80, MX200 G2, MX300 G2, MX700, MX800)

Video Output Monitor [n] Position (SX20, SX80, MX200 G2, MX300 G2, MX700, MX800)

Video Output Monitor [n] SerialNumber (SX20, SX80, MX200 G2, MX300 G2, MX700, MX800)

Video Output Monitor [n] Temperature

(SX20, SX80, MX200 G2, MX300 G2, MX700, MX800)

Statuses that are removed

Video Output Connector [n] ConnectedDevice CEC [n] PowerControl (All products)

API Reference Guide

Appendices xCommand xStatus

Statuses that are modified

Peripherals ConnectedDevice [n] Type

(All products)

OLD: Byod/Camera/ControlSystem/ISDNLink/Other/SpeakerTracker/TouchPanel

NEW: Byod/Camera/ControlSystem/ISDNLink/Other/SpeakerTracker/TouchPanel/

InputDevice

SystemUnit Software OptionKeys MultiSite (SX20, SX80, Codec Plus, Codec Pro, Room Kit, MX200 G2,

MX300 G2, MX700, MX800, Room 55, Room 70, Room 70 G2)

OLD: False/True

NEW: False/True/NotApplicable

Cisco Collaboration Endpoint Software



Introduction About the API

What’s new in CE9.4

This section provides an overview of the new and changed device settings, and the new features and improvements in the Cisco Collaboration Endpoint software version 9.4 (CE9.4) compared to CE9.3.

For more details, we recommend reading the Software release notes:

 https://www.cisco.com/c/en/us/support/collaboration-endpoints/telepresence-quick-set-series/ products-release-notes-list.html

xConfiguration xCommand xStatus

API Reference Guide

Appendices

New features and improvements

New products

• Cisco Webex Codec Pro

• Cisco Webex Room 70 Single G2

• Cisco Webex Room 70 Dual G2

• Cisco Webex Room 55 Dual

Rebranding from Cisco Spark to Cisco Webex (All products)

Cisco Spark has changed its name to Cisco Webex, and the user interface elements that displayed Spark are changed to

Webex . In the activation flow you now see Cisco Webex as a registration option instead of Cisco Spark.

The following products have gotten new names:

• Cisco Spark Room Kit is now Cisco Webex Room Kit

• Cisco Spark Room Kit Plus is now Cisco Webex Room Kit

Plus

• Cisco Spark Codec Plus is now Cisco Webex Codec Plus

• Cisco Spark Quad Camera is now Cisco Quad Camera

• Cisco Spark Room 55 and 70 are now Cisco Webex

Room 55 and 70

• Cisco DX70 is now Cisco Webex DX70

• Cisco DX80 is now Cisco Webex DX80

The maximum number of Proximity clients is increased

(Codec Plus, Codec Pro, Room 55, Room 55 Dual, Room 70, Room 70 G2, Room

Kit)

A Cisco Webex Room Series device can have up to 30 paired clients simultaneously when the Proximity service

ContentShare ToClients is disabled. If ContentShare ToClients is enabled, the limit of paired clients is 7 which is the same as in earlier software releases.

CUCM provisioning of the admin settings lockdown configuration (All products)

The admin settings lockdown configuration, that was introduced in CE9.2.1, can now be provisioned from CUCM. You can lock a selection of the settings on the settings menu on all of your devices simultaneously when you configure them through CUCM.

Your CUCM may require a device package in order to expose the new fields for this configuration.

Support for content sharing using H.263 in a call between

Cisco Webex Room Series and legacy MXP devices

(Codec Plus, Codec Pro, Room 55, Room 55 Dual, Room 70, Room 70 G2, Room

Kit)

Support for H.263 content sharing between MXP and Cisco

Webex Room Series is now available. The Room Series previously had a limitation where it could not receive or share content in a separate content channel. Sharing content from a

Room Series device to a MXP device would in earlier versions compose the presentation into the main video stream.

This is only supported in certain scenarios:

• Direct H.323 calls (IP dialing) between a Room Series device and a MXP device.

• MXP registered on VCS on H.323 and a Room Series device registered to the same VCS on either SIP or

H.323. Note that making a H.323 to SIP call on a VCS requires that an interworking option key is installed on the

VCS.

See  the CE9 release notes for information on other limitations related to this feature.

Cisco Collaboration Endpoint Software



Introduction About the API

Enable backlight compensation from the touch screen

(DX70, DX80)

A new setting on the DX70 and DX80 main menu enables and disables backlight compensation. This is a fixed setting that increases (on) or decreases (off) the sensors brightness levels in order to compensate for sunlight or other bright light sources behind the user. The backlight compensation sets the sensor to a fixed level and it is not auto adjusted to the backlight.

Changed default HTTP mode from HTTP+HTTPS to HTTPS

(All products)

The default value of NetworkServices HTTP Mode is changed from HTTP+HTTPS to HTTPS. This is to increase the security of the room devices on default configuration. Upgrading from earlier software versions will not automatically change the default value and it will stay on HTTP+HTTPS to avoid breaking current HTTP implementations.

The change is seen on new devices running CE9.4.0 or later, or if the device is factory reset on CE9.4.0. The HTTP requests are redirect to HTTPS and on the first visit to the device’s web interface, the device displays an “Insecure connection warning”. To proceed to the web interface, you need to create an exception in your browser. This is a one-time operation unless you access the web interface with a different browser that has never visited the device web interface or if the device is factory reset.

In-Room Control update (All products)

You can add buttons for as many panels as you want on the home screen as well as on the in-call screen of the user interface.

xConfiguration xCommand xStatus

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xConfiguration changes in CE9.4

New configurations

Audio Input Microphone [n] PhantomPower

(Codec Pro, Room 70 G2)

Audio Input HDMI [n] Mode

(Room 55, Codec Pro)

Audio Input HDMI [n] VideoAssociation MuteOnInactiveVideo (Room 55, Codec Pro)

Audio Output HDMI [n] Delay DelayMs (Codec Pro)

Audio Output HDMI [n] Delay Mode (Codec Pro)

Audio Output Line [1] OutputType (Room 70, Room 55D)

Cameras Camera [1] Backlight DefaultMode (DX70, DX80)

Cameras Camera [1..2] Mirror (MX700, MX800)

Conference FarendMessage Mode (All products)

Configurations that are removed

NetworkServices HTTP Proxy Allowed (All products)

Video Output Connector [2] CEC Mode (DX70, DX80)

Video Output Connector [2] OverscanLevel (DX70, DX80)

Video Output Connector [2] Resolution (DX70, DX80) xCommand xStatus

Configurations that are modified

Audio Output Line [1] OutputType

(Room Kit)

OLD: Default value: LineOut

NEW: Default value: Loudspeaker

OLD: Value space: LineOut/Subwoofer

NEW: Value space: LineOut/Loudspeaker/Recorder/Subwoofer

Audio Ultrasound MaxVolume

(MX200 G2, MX300 G2, Codec Plus, Room 70)

OLD: Default value: 60 (MX200 G2, MX300 G2)

70 (Codec Plus, Room 55, Room 70)

NEW: Default value: 50 (MX200 G2, MX300 G2)

60 (Codec Plus, Room 70)

64 (Room 55)

OLD: Value space: Integer (0..80) (MX200 G2, MX300 G2)

Integer (0..90) (Room 55, Room 70)

NEW: Value space: Integer (0..70)

(MX200 G2, MX300 G2)

Integer (0..80)

(Room 70)

Integer (0..84)

(Room 55)

Network [1] DNS DNSSEC Mode (All products)

OLD: User role: ADMIN, USER

NEW: User role: ADMIN

Network [1] Speed (All products)

OLD: User role: ADMIN, USER

NEW: User role: ADMIN, INTEGRATOR

NetworkServices HTTP Mode (All products)

OLD: Default value: HTTP+HTTPS

NEW: Default value: HTTPS

NetworkServices SNMP CommunityName

(All products)

OLD: User role: ADMIN

NEW: User role: ADMIN, INTEGRATOR

NetworkServices SNMP Host [1..3] Address (All products)

OLD: User role: ADMIN

NEW: User role: ADMIN, INTEGRATOR

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration

NetworkServices SNMP Mode

(All products)

OLD: User role: ADMIN

NEW: User role: ADMIN, INTEGRATOR

NetworkServices SNMP SystemContact (All products)

OLD: User role: ADMIN

NEW: User role: ADMIN, INTEGRATOR

NetworkServices SNMP SystemLocation

(All products)

OLD: User role: ADMIN

NEW: User role: ADMIN, INTEGRATOR

UserInterface ContactInfo Type (SX10, DX70, DX80)

OLD: Value space: Auto/DisplayName/IPv4/IPv6/None/SipUri/SystemName

NEW: Value space: Auto/DisplayName/E164Alias/H320Number/H323Id/IPv4/IPv6/None/

SipUri/SystemName

Video Output Connector [1] CEC Mode (SX10)

OLD: Default value: Off

NEW: Default value: On

Video Output Connector [3] Resolution (SX80)

OLD: User role: ADMIN, INTEGRATOR

NEW: User role: ADMIN, INTEGRATOR, USER xCommand xStatus

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API xCommands changes in CE9.4

New commands

Audio LocalInput Add

(MX700, MX800)

Audio LocalInput AddConnector

(MX700, MX800)

Audio LocalInput Remove (MX700, MX800)

Audio LocalInput RemoveConnector (MX700, MX800)

Audio LocalInput Update (MX700, MX800)

Audio LocalOutput Add (MX700, MX800)

Audio LocalOutput AddConnector (MX700, MX800)

Audio LocalOutput ConnectInput (MX700, MX800)

Audio LocalOutput DisconnectInput (MX700, MX800)

Audio LocalOutput Remove (MX700, MX800)

Audio LocalOutput RemoveConnector

(MX700, MX800)

Audio LocalOutput Update

(MX700, MX800)

Audio LocalOutput UpdateInputGain (MX700, MX800)

Audio RemoteOutput ConnectInput (MX700, MX800)

Audio RemoteOutput DisconnectInput (MX700, MX800)

Audio RemoteOutput UpdateInputGain (MX700, MX800)

Audio Setup Clear (MX700, MX800)

Call FarEndMessage Send (All products)

Provisioning RoomType Activate (SX80, MX700, MX800, Codec Pro, Room 70 G2)

Security FIPSMode Activate (All products)

Video Matrix Assign

(Room Kit, Codec Pro, Room 70 G2)

Video Matrix Reset

(Room Kit, Codec Pro, Room 70 G2)

Video Matrix Swap

(Room Kit, Codec Pro, Room 70 G2)

Video Matrix Unassign (Room Kit, Codec Pro, Room 70 G2)

Commands that are removed

None.

xConfiguration

D15407.13 Cisco Collaboration Endpoint Software API Reference Guide CE9.12, APRIL 2020 42

API Reference Guide

Appendices xCommand xStatus

Commands that are modified

Audio LocalInput Add

(SX80)

NEW: Direct: On/Off

Audio LocalInput Update (SX80)

NEW: Direct: On/Off

OLD: AGC, Channels, MixerMode, Mute, Name: Required parameters

NEW: AGC, Channels, MixerMode, Mute, Name: Optional parameters

Audio LocalOutput Update (SX80)

OLD: Channels, Loundspeaker, Name: Required parameters

NEW: Channels, Loundspeaker, Name: Optional parameters

Camera PositionSet (All products except DX70, DX80)

OLD: Zoom: Integer (0..8500)

NEW: Zoom: Integer (0..11800)

Conference DoNotDisturb Activate (All products)

OLD: User role: ADMIN, USER

NEW: User role: ADMIN, INTEGRATOR, USER

Conference DoNotDisturb Deactivate

(All products)

OLD: User role: ADMIN, USER

NEW: User role: ADMIN, INTEGRATOR, USER

SystemUnit FactoryReset (All products)

OLD: Keep: Certificates/LocalSetup/Network/Provisioning/SerialPort/Spark

NEW: Keep: Certificates/LocalSetup/Network/Provisioning/SerialPort/Spark/HTTP

SystemUnit SoftwareUpgrade (All products)

Removed: UserName, Password

UserManagement User Modify

(All products)

NEW: Unblock: False/True

Video Selfview Set (All products)

OLD: User role: ADMIN, USER

NEW: User role: ADMIN, INTEGRATOR, USER

OLD: OnMonitorRole: First/Second/Third

NEW: OnMonitorRole: First/Second/Third/Fourth

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xStatus changes in CE9.4

New statuses

Audio Input LocalInput [n] Direct

(SX80, MX700, MX800)

Audio Output Connectors HDMI [n] DelayMs

(Room Kit, Codec Plus, Codec Pro, Room 70, Room 70 G2,

Room 55D)

Audio Output Connectors HDMI [n] Mode (Room Kit, Codec Plus, Codec Pro, Room 70, Room 70 G2, Room

55D)

Audio Output Connectors InternalSpeaker [n] DelayMs (Room Kit, Codec Plus, Codec Pro, Room 70,

Room 70 G2, Room 55D)

Audio Output Connectors InternalSpeaker [n] Mode (Codec Plus, Codec Pro, Room 55D, Room 70, Room

70 G2)

Audio Output MeasuredHdmiArcDelay (All products)

Audio Output MeasuredHdmiDelay

(All products)

Audio Output ReportedHdmiCecDelay

(All products)

Cameras Camera [n] LightingConditions (Room Kit, Room 55, Codec Plus, Codec Pro, Room 70, Room 70

G2, Room 55D)

Cameras Camera [n] Position Lens (Codec Pro, Room 70, Room 70 G2, Room 55D)

Network [n] IPv6 LinkLocalAddress

(All products)

RoomPreset [n] Defined

(All products except DX70 and DX80)

RoomPreset [n] Description (All products except DX70 and DX80)

RoomPreset [n] Type (All products except DX70 and DX80)

SystemUnit Hardware TemperatureThreshold (SX80, SX20, SX10, MX200 G2, MX300 G2, MX700, MX800,

DX70, DX80)

Statuses that are removed

None.

xCommand xStatus

API Reference Guide

Appendices

Statuses that are modified

Diagnostics Message [n] Type

(All products)

NEW: Value space: SparkActivationRequired and SparkConnectivity removed

Video Monitors (All products)

OLD: Valuespace: Dual/DualPresentationOnly/Single/Triple/TriplePresentationOnly

NEW: Valuespace: Dual/DualPresentationOnly/Single/Triple/TriplePresentationOnly/

Quadruple

Video Output Connector [n] MonitorRole (All products)

OLD: Valuespace: First/InternalSetup/PresentationOnly/Recorder/Second/Third

NEW: Valuespace: First/InternalSetup/PresentationOnly/Recorder/Second/Third/Fourth

Video Selfview OnMonitorRole

(All products)

OLD: Valuespace: First/Second/Third

NEW: Valuespace: First/Second/Third/Fourth

Cisco Collaboration Endpoint Software



Introduction About the API

What’s new in CE9.3

This section provides an overview of the new and changed device settings, and the new features and improvements in the Cisco Collaboration Endpoint software version 9.3 (CE9.3) compared to CE9.2.

For more details, we recommend reading the Software release notes:

 https://www.cisco.com/c/en/us/support/collaboration-endpoints/telepresence-quick-set-series/ products-release-notes-list.html

xConfiguration xCommand xStatus

API Reference Guide

Appendices

New features and improvements

Backup and restore settings and custom elements

(All products)

You can include custom elements as well as configurations in a backup file bundle (zip). You can choose which of the following elements to include in the bundle:

• Branding images

• Macros

• Favorites

• Sign-in banner

• In-room control panels

• Configurations (all or a sub-set)

In previous software versions, you could only backup the configurations.

The backup file can either be restored manually from the device’s web interface, or you can generalize the backup bundle so that it can be provisioned across multiple devices, for example using Cisco UCM or TMS.

You will find the backup and restore functionality under

Maintenance > Backup and Restore on the device’s web interface.

Provisioning of custom elements (All products)

The backup bundle, as described above, can be provisioned to many devices using Cisco UCM or TMS. It is important that device specific information is removed when creating a backup bundle intended for multiple devices. If you include device specific information in such a bundle, you may end up with multiple devices that cannot be reached.

By provisioning a non-device specific backup bundle, you can for example, copy a device’s setup with macros, branding elements, and in-room control panels across multiple devices.

Currently, provisioning via Cisco UCM will not restore any configurations, only the other custom elements; TMS will restore everything that is included in the backup bundle.

See the release note for more details about provisioning.

In-Room Control updates (All products)

The following functionality is added to the in-room control feature:

• You can add buttons for up to 20 panels in total. The buttons appear on the home screen or the in-call screen of the user interface depending on the panel type.

• As before, there are three types of in-room control panels: global panels (always available), in-call panels

(available only when in call), and out-of-call panels (only available when not in a call). The entry point for the global panel has been removed from the status bar (top right corner of the user interface). Buttons to open global panels are added to both the home screen and the in-call screen instead, together with the buttons for the out-ofcall only and in-call only panels, respectively.

• You can make standalone trigger-buttons, which are buttons that trigger an event directly, without opening a panel on the user interface.

Also the following features are added in the in-room control editor:

• Some new icons are available.

• A set of colors to choose from for the in-room-control buttons.

• Double click text elements to edit text directly.

• Drag and drop in-room control XML files into the editor.

For a full description of in-room controls, see the

Cusomization guide for CE9.3 at  https://www.cisco.com/ go/in-room-control-docs

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xCommand

Support for ISDN Link

(All products)

ISDN Link with software version IL1.1.7 is supported for all video conferencing devices that supports CE9.3.0.

As before, when using automatic pairing (which allows the

ISDN Link to be automatically discovered by the device) IPv6 must be enabled on the device.

One Button to Push snooze (All products)

You are able to snooze an One Button to Push (OBTP) meeting reminder for 5 minutes. The snooze time cannot be changed. The reminder typically appears if you are in a call and a scheduled meeting is about to start. You can snooze the reminder for 5 minutes each time it appears until the meeting has ended.

Screen status monitoring and control

(SX10)

SX10 now has the same CEC (Consumer Electronics Control) behavior as the devices in the Room series.

The device will use CEC to set the screen in standby when the device itself enters standby, and wake up the screen and select the correct video input when the device itself wakes up from standby. CEC information from the screen is included in the device’s status. Of course, the screen must also support

CEC and send the relevant information to the device.

CEC is disabled on the device by default, and must be enabled in the Video Output Connector [1] CEC Mode setting.

Adjust the call rate before making a call

(All products)

As soon as you start typing in the Search or dial field, you can open a dialog and select a custom call rate. In earlier releases this was available only when selecting an entry from the Directory.

If you don’t select a custom call rate, you get the rate set in the Conference DefaultCall Rate setting.

Select ring-tone and adjust ring-tone volume

(All products)

You can select a ring-tone and adjust the ring-tone volume from the settings menu on the user interface. In the previous releases this was done from the web interface.

Resume a postponed upgrade (All products)

When you get a notification about software upgrade, you can choose Upgrade now or Postpone . If you postpone the upgrade, you can resume the upgrade from the Settings

> About this device menu on the user interface when you are ready; you don’t have to wait for 6 hours like you had to before.

If you don’t manually resume the upgrade, the upgrade will start automatically after 6 hours.

Prevent device information from being exposed in the user interface (All products)

You can prevent important device information from being exposed in the user interface, for example:

• IP addresses (video system, touch controller, UCM/VCS registrar)

• MAC address

• Serial number

• Software version

To enable this feature the following must be done:

• A passphrase must be set for all users with administrator rights

• UserInterface SettingsMenu Mode must be set to Locked

• UserInterface Security Mode must be set to Strong

This feature also means that the IP address is not displayed on the screen when you disconnect a Touch controller.

xStatus

API Reference Guide

Appendices

Accessibility: Flashing screen on incoming calls

(All products)

You can configure the device so that the screen and Touch controller flashes red / light grey when the system receives an incoming call. This feature is mainly targeting hearing impaired users, making it easier for them to notice an incoming call.

The feature is disabled by default, and must be enabled by the Accessibility IncomingCallNotification setting.

Mirrored self-view (DX70 and DX80)

You can configure the device to show the self-view image the way other people see you, or as you would see yourself in a mirror. Use the Video Selfview Mirrored setting. Mirrored self-view used to be available only for Cisco DX devices running Android software.

Mirroring only applies to the self-view image, and has no effect on the video that is sent to the far end.

One common API guide

We have gathered all API information in one API guide, that covers all products. This is in contrast to earlier releases were we have had one API guide per product.

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration changes in CE9.3

New configurations

Audio KeyClickDetector Attenuate

(Room Kit, Codec Plus, Room 55, Room 70)

Audio KeyClickDetector Enabled

(Room Kit, Codec Plus, Room 55, Room 70)

Cameras Camera [1..3] AssignedSerialNumber (Codec Plus, Room 70)

Cameras Camera [3] Backlight DefaultMode (Codec Plus, Room 70)

Cameras Camera [3] Brightness DefaultLevel (Codec Plus, Room 70)

Cameras Camera [3] Brightness Mode (Codec Plus, Room 70)

Cameras Camera [3] Focus Mode (Codec Plus, Room 70)

Cameras Camera [3] Gamma Level (Codec Plus, Room 70)

Cameras Camera [3] Gamma Mode (Codec Plus, Room 70)

Cameras Camera [3] Mirror (Codec Plus, Room 70)

Cameras Camera [3] Whitebalance Level

(Codec Plus, Room 70)

Cameras Camera [3] Whitebalance Mode

(Codec Plus, Room 70)

Network [1] DNS DNSSEC Mode (All products)

NetworkServices HTTP Proxy PACUrl (All products)

SystemUnit CrashReporting Mode (All products)

SystemUnit CrashReporting URL (All products)

UserInterface Accessibility IncomingCallNotification (All products)

UserInterface Security Mode (All products)

Video Selfview Mirrored (DX70/DX80)

Configurations that are removed

Provisioning HttpMethod (All products) xConfiguration xCommand xStatus

Configurations that are modified

NetworkServices HTTP Proxy Allowed

(All products)

OLD: Default value: True

NEW: Default value: False

NetworkServices HTTP Proxy Mode (All products)

OLD: Value space: Manual/Off

NEW: Value space: Manual/Off/PACUrl/WPAD

Proximity Mode (Room 70)

OLD: Default value: Off

NEW: Default value: On

Standby WakeupOnMotionDetection (Room 70)

OLD: Default value: Off

NEW: Default value: On

Video Input Connector [2] Name (Room 55)

OLD: Default value: “PC 1 (HDMI)”

NEW: Default value: “”

Video Input Connector [3] Name

(Room 55)

OLD: Default value: “PC 2 (HDMI)”

NEW: Default value: “”

Video Input Connector [1] CEC Mode (Room 70)

OLD: Value space: Off/On

NEW: Value space: On

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xCommands changes in CE9.3

New commands

Audio SoundsAndAlerts Ringtone Stop

(All products)

Bookings NotificationSnooze

(All products)

HttpFeedback Enable (All products)

Macros Macro RemoveAll (All products)

Provisioning Service Fetch (All products)

Standby ResetHalfwakeTimer (All products)

UserInterface Branding Clear (All products)

UserInterface Extensions Panel Clicked (All products)

UserInterface Extensions Panel Remove (All products)

UserInterface Extensions Panel Save (All products)

Video CEC Output KeyClick

(SX10)

Video CEC Output SendActiveSourceRequest

(Codec Plus, Room 55, Room 70, Room Kit, SX10)

Video Matrix Assign (Codec Plus)

Video Matrix Reset (Codec Plus)

Video Matrix Swap (Codec Plus)

Video Matrix Unassign (Codec Plus)

Commands that are removed

Provisioning StartUpgrade (All products)

API Reference Guide

Appendices xCommand xStatus

Commands that are modified

Audio Sound Play

(All products)

OLD: Sound: Alert/Bump/Busy/CallDisconnect/CallInitiate/CallWaiting/Dial/KeyInput/

KeyInputDelete/KeyTone/Nav/NavBack/Notification/OK/Pairing/PresentationConnect/

Ringing/SignIn/SpecialInfo/TelephoneCall/VideoCall/VolumeAdjust/WakeUp

NEW: Sound: Alert/Bump/Busy/CallDisconnect/CallInitiate/CallWaiting/Dial/KeyInput/

KeyInputDelete/KeyTone/Nav/NavBack/Notification/OK/Pairing/PresentationConnect/

Ringing/SignIn/SpecialInfo/TelephoneCall/VideoCall/VolumeAdjust/WakeUp/StartListening

Audio SoundsAndAlerts Ringtone Play (All products)

NEW: Loop: On/Off

Dial (DX70, DX80)

OLD: CallRate: Integer (64..3072)

NEW: CallRate: Integer (64..6000)

Dial

(All products)

NEW: TrackingData: String (0, 255)

Macros Macro Save (Codec Plus, DX70, DX80, MX200 G2, MX300 G2, MX700, MX800, Room 55, Room 70,

Room Kit, SX20, SX80)

NEW: Transpile: False/True

Peripherals List (All products)

NEW: Type: Default: All

SystemUnit ProductPlatform Set (Codec Plus, Room 70)

OLD: Platform: ROOM70D/ROOM70S

NEW: Platform: ROOM70D/ROOM70S/ROOM55D

UserInterface Extensions Widget Action (All products)

OLD: WidgetId: String (0, 40)

NEW: WidgetId: String (0, 255)

Cisco Collaboration Endpoint Software



Introduction About the API

UserInterface Extensions Widget SetValue (All products)

OLD: WidgetId: String (0, 40)

NEW: WidgetId: String (0, 255)

UserInterface Extensions Widget UnsetValue (All products)

OLD: WidgetId: String (0, 40)

NEW: WidgetId: String (0, 255)

Video Matrix Assign (MX200 G2, MX300 G2, MX800, MX700, SX20, SX80)

OLD: User role: ADMIN, USER

NEW: User role: ADMIN, INTEGRATOR, USER

Video Matrix Reset (MX200 G2, MX300 G2, MX800, MX700, SX20, SX80)

OLD: User role: ADMIN, USER

NEW: User role: ADMIN, INTEGRATOR, USER

Video Matrix Swap

(MX200 G2, MX300 G2, MX800, MX700, SX20, SX80)

OLD: User role: ADMIN, USER

NEW: User role: ADMIN, INTEGRATOR, USER

Video Matrix Unassign (MX200 G2, MX300 G2, MX800, MX700, SX20, SX80)

OLD: User role: ADMIN, USER

NEW: User role: ADMIN, INTEGRATOR, USER xConfiguration xCommand xStatus

API Reference Guide

Appendices

Cisco Collaboration Endpoint Software



Introduction About the API xConfiguration xStatus changes in CE9.3

New statuses

Audio Input KeyClick Attenuate

(Codec Plus, Room 55, Room 70, Room Kit)

Audio Input KeyClick Enabled

(Codec Plus, Room 55, Room 70, Room Kit)

Audio Input KeyClick Detected (Codec Plus, Room 55, Room 70, Room Kit)

HttpFeedback [n] Status (All products)

Peripherals ConnectedDevice [n] UpgradeFailureReason (All products)

Peripherals ConnectedDevice [n] UpgradeURL (All products)

Provisioning RoomType (MX700, MX800, SX80)

Provisioning Software UpgradeStatus Urgency (All products)

Video Output Monitor [n] FirmwareVersion (Codec Plus, Room 55, Room 70, Room Kit, SX10)

Video Output Monitor [n] ModelName (Codec Plus, Room 55, Room 70, Room Kit, SX10)

Video Output Monitor [n] Position

(Codec Plus, Room 55, Room Kit)

Video Output Monitor [n] SerialNumber

(Codec Plus, Room 55, Room 70, Room Kit, SX10)

Video Output Monitor [n] Temperature (Codec Plus, Room 55, Room 70, Room Kit, SX10)

Statuses that are removed

MediaChannels Call [n] Channel [n] Netstat Drop (All products)

USB Device [n] State (SX20)

USB Device [n] Type (SX20)

Statuses that are modified

Cameras Camera [n] Flip (Codec Plus, MX700, MX800, Room 70, SX10, SX20, SX80)

OLD: String

NEW: Off/On

Diagnostics Message [n] Type (All products)

OLD: ANATOnVCS/AbnormalCallTermination/AudioInternalSpeakerDisabled/

AudioPairingInterference/AudioPairingNoise/AudioPairingRate/

AudioPairingSNR/AudioPairingTokenDecode/CAPFOperationState/

CTLinstallation/CUCMVendorConfigurationFile/CallProtocolDualStackConfig/

CallProtocolIPStackPlatformCompatibility/CallProtocolVcsProvisioningCompatibility/

D15407.13 Cisco Collaboration Endpoint Software API Reference Guide CE9.12, APRIL 2020 49

API Reference Guide

Appendices xCommand xStatus

CameraDetected/CameraId/CameraPairing/CameraSerial/CameraSoftwareVersion/

CameraStatus/CamerasDetected/CaptivePortalDetected/CertificateExpiry/

ConfigurationFile/ContactInfoMismatch/ControlSystemConnection/

DefaultCallProtocolRegistered/ECReferenceDelay/EthernetDuplexMatches/FanStatus/

FirstTimeWizardNotCompleted/H320GatewayStatus/H323GatekeeperStatus/

HasActiveCallProtocol/HasValidReleaseKey/IPv4Assignment/IPv6Assignment/IPv6Mtu/

ISDNLinkCompatibility/ISDNLinkIpStack/ITLinstallation/InvalidSIPTransportConfig/

IpCameraStatus/LockDown/MediaBlockingDetected/MediaPortRangeNegative/

MediaPortRangeOdd/MediaPortRangeOverlap/MediaPortRangeTooSmall/

MediaPortRangeValueSpace/MicrophoneReinforcement/MicrophonesConnected/

MonitorDelay/NTPStatus/NetLinkStatus/NetSpeedAutoNegotiated/NetworkQuality/

OSDVideoOutput/OutputConnectorLocations/PlatformSanity/PresentationSourceSelection/

PresenterTrack/ProvisioningDeveloperOptions/ProvisioningStatus/RoomControl/

SIPEncryption/SIPListenPortAndOutboundMode/SIPListenPortAndRegistration/

SIPProfileRegistration/SIPProfileType/SelectedVideoInputSourceConnected/

SipIceAndAnatConflict/SipOrH323ButNotBothEnabled/SoftwareUpgrade/

SparkActivationRequired/SparkConnectivity/SpeakerTrackEthernetConnection/

SpeakerTrackFrontPanelMountedCorrectly/SpeakerTrackMicrophoneConnection/

SpeakerTrackVideoInputs/TCPMediaFallback/TLSVerifyRequiredCerts/TemperatureCheck/

TouchPanelConnection/TurnBandwidth/UltrasoundSpeakerAvailability/ValidPasswords/

VideoFromInternalCamera/VideoInputSignalQuality/VideoInputStability/

VideoPortRangeNegative/VideoPortRangeOdd/VideoPortRangeTooSmall/

VideoPortRangeValueSpace/WifiCARequired/ActiveMacros/AudioECRefDelay

NEW: ANATOnVCS/AbnormalCallTermination/AudioInternalSpeakerDisabled/