Page 1 About the API xConfiguration xCommand xStatus Appendices Software version CE9.1 JUNE 2017 Application Programming Interface (API) Reference Guide Cisco TelePresence SX20 Codec SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 2: Table Of Contents
Commands ................20 The SystemTools commands ..........191 Configurations ...............20 About disconnect cause types ........... 193 Status ..................20 User documentation on the Cisco web site ......194 Events ................... 21 Feedback mechanism ............22 Feedback expressions ............22 Terminal connections ............23 SX20 Codec API Reference Guide CE9.1, JUNE 2017.
Page 3: Introduction
Cisco TelePresence SX20 Codec API Reference Guide  Introduction Introduction About the API xConfiguration xCommand xStatus Appendices Chapter 1 Introduction SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 4: About This Guide
For Spark registred systems, go to: following product: https://support.ciscospark.com • Cisco TelePresence SX20 Codec Guidelines for how to find the documentation on the Cisco web site are included in the User documentation on the Cisco web site appendix. The guide describes the API for on-premise registered video systems (CUCM, VCS) as well as video systems registered to Cisco’s cloud service (Cisco Spark).
Page 5: What's New In Ce9.1
The feature is based on ultrasound, and it does not keep record of who was in the room, only whether or not the room is in use. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 6 Network[ 1] IEEE8021X Password OLD: Valuespace: String(0, 32) NEW: Valuespace: String(0, 50) Video Input Connector [n] PresentationSelection OLD: Valuespace: AutoShare/Manual/OnConnect NEW: Valuespace: AutoShare/Desktop/Manual/OnConnect SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 7 Commands that are removed None. Commands that are modified SystemUnit FactoryReset (All products) OLD: Keep: LocalSetup/Network/Spark/Provisioning NEW: Keep: LocalSetup/Network/Spark/Provisioning/SerialPort/Certificates (not in use) SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 8 : CAPFOperationState / CTLinstallation / CUCMVendorConfigurationFile / CallProtocolDualStackConfig / CallProtocolIPStackPlatformCompatibility / CallProtocolVcsProvisioningCompatibility / CameraId / CameraPairing / CameraSerial / CameraSoftwareVersion / CameraStatus / CamerasDetected / CamerasDetectedNoIr SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 9: What's New In Ce9.0
Standby WakeupOnMotionDetection You can’t manually place the system in standby when this feature is enabled. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 10 <path> * means that the change applies to all configurations starting with <path>. Audio Output Line [n] * Audio SoundsAndAlerts * Cameras Camera [n] * Conference DefaultCall Rate Conference DoNotDisturb DefaultTimeout SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 11 Audio SoundsAndAlerts Ringtone Play Audio Sound Stop Peripherals Connect Peripherals List Standby Activate Standby Deactivate SystemUnit Boot UserInterface Extensions Clear UserInterface Extensions List SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 12 ITLinstallation, InvalidSIPTransportConfig, LockDown, RoomControl, Cameras Camera[n] Position Pan MediaBlockingDetected, NetLinkStatus, NetSpeedAutoNegotiated, NetworkQuality, Cameras Camera[n] Position Tilt NTPStatus, OSDVideoOutput, OutputConnectorLocations, ProvisioningDeveloperOptions, ProvisioningStatus, SIPEncryption, SIPListenPortAndOutboundMode, SIPProfileRegistration, SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 13 Video Input Connector[n] SignalState Video Input Connector[n] SourceId Video Input Connector[n] Type Video Input Source[n] ConnectorId Video Input Source[n] FormatStatus Video Input Source[n] FormatType SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 14: About The Api
Cisco TelePresence SX20 Codec API Reference Guide  Introduction Introduction About the API xConfiguration xCommand xStatus Appendices Chapter 2 About the API SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 15: Api Fundamentals
POST and GET methods are used to execute commands and get feedback from the codec. This is described in ”Using HTTP” on page 24 in this document. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 16: Rs-232 / Serial Connection
Cisco Spark registered systems xConfiguration SerialPort LoginRequired: <Off/On> If a video system is registered to Cisco’s cloud service (Cisco Spark), only local users with the INTEGRATOR and ROOMCONTROL user roles are available.
Page 17: Api Output
To set output mode to XML, issue the command: </Audio> xPreferences outputmode xml </Command> To revert to terminal mode, issue the command: xPreferences outputmode terminal SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 18: Using The Command Line
Echo <on/off> Refer to ”Configurations” on page can be used for advanced troubleshooting together with Cisco technical support. Systemtools are not a part of the If echo is set to the key inputs are displayed when enter- programming API. Refer to ”The SystemTools commands”...
Page 19: Command Line Shortcuts
XCOMMAND DIAL NUMBER: foo@bar.org *s Video Output Connector 3 Resolution Width: 1280 xcommand dial number: foo@bar.org ** end xCommand Dial Number: foo@bar.org SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 20: Commands
Write in: is separated with ‘:’. xConfiguration H323 Profile 1 H323Alias ID Result: *c xConfiguration H323 Profile 1 H323Alias ID: “changed@company.com” **end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 21: Events
** end and established. *e CallSuccessful CallId: 132 Protocol: “h223” Direction: “outgoing” CallRate: 768 RemoteURI: “h223:integratorHQ@company.com” EncryptionIn: “Off” EncryptionOut: “Off” ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 22: Feedback Mechanism
Video Input Connector 3 Name *c xConfiguration Video Input Connector 3 Name: “NameC” ** end Equivalent feedback expression xFeedback register /Configuration/Video/Input/ Connector[@item=’3’]/Name SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 23: Terminal Connections
Write in: xFeedback deregister /Status/Audio Result: ** end D: List the new feedback expressions. Write in: xFeedback list Result: /Configuration/Video/MainVideoSource ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 24: Using Http
Response: GET /configuration.xml HTTP/1.1 HTTP/1.1 204 No Content Cookie: SessionId=f08102c8ce5aaf8fba23a7238cc2ef46 Server: nginx/1.8.0 4b990e18bfbb7fb048820c0e28955c54 Connection: keep-alive Set-Cookie: SessionId=; Max-Age=0; Path=/; HttpOnly SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 25: Getting Status And Configurations
</Camera> <Configuration> </Command> <SystemUnit> Response <Name>newName</Name> HTTP/1.1 200 OK </SystemUnit> Content-Type: text/xml </Configuration> Content-Length: 91 <?xml version=”1.0”?> <Command> <CameraPositionSetResult item=”1” status=”OK”/> </Command> SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 26: Feedback From Codec Over Http
JSON format. You can subscribe to changes on multiple Cisco TelePresence Management Suite (TMS) is used as TMS codec from which the notification originated. This means that parts of the API by register up to 15 different feedback uses this feedback slot to register its expressions.
Page 27: Translating From Terminal Mode To Xml
Example 2: Assigning volume level </Input> </Video> Terminal </Configuration> xCommand Audio Volume Set Level: 50 <Command> <Audio> <Volume> <Set command=”True”> <Level>50</Level> </Set> </Volume> </Audio> </Command> SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 28: Dos And Don'ts
Appendices Dos and don’ts Here are some best practices when programming the Cisco SX series API. AVOID remote control emulation The use of xCommand UserInterface OSD Key Click and discouraged. The commands are still available in the API, but backwards compatibility in your integrations.
Page 29: Xconfiguration Commands
Cisco TelePresence SX20 Codec API Reference Guide  Introduction About the API xConfiguration xConfiguration xCommand xStatus Appendices Chapter 3 xConfiguration commands SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 30: Description Of The Xconfiguration Commands
H323 Encryption KeySize ....................45 xConfiguration Cameras Camera [1] Mirror ....................39 xConfiguration H323 Gatekeeper Address ....................45 xConfiguration Cameras Camera [1] Whitebalance Mode .................39 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 31 Phonebook configuration ........................63 xConfiguration Network [1] QoS Diffserv Signalling ...................54 xConfiguration Phonebook Server [1] ID ....................63 xConfiguration Network [1] QoS Diffserv ICMPv6 ..................55 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 32 UserManagement LDAP Mode ..................78 xConfiguration SIP DefaultTransport ......................70 xConfiguration UserManagement LDAP Server Address ................78 xConfiguration SIP DisplayName ........................70 xConfiguration UserManagement LDAP Server Port .................78 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 33 Video Selfview Default OnMonitorRole ................86 xConfiguration Video Selfview Default PIPPosition ..................87 xConfiguration Video Selfview OnCall Mode .....................87 xConfiguration Video Selfview OnCall Duration ..................87 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 34: Audio Configuration
When set to InCallOnly this will prevent the audio-system from being muted by mistake. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 35: Xconfiguration Audio Input Line [1] Videoassociation Muteoninactivevideo
Select the video input connector to associate the audio source with. Off: Turn off the noise reduction. On: Turn on the noise reduction. Recommended in the presence of low frequency noise. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 36: Xconfiguration Audio Input Microphone [1
: Integer (0..24) Level : Integer (0..290) DelayMs Select a value between 0 and 24, in steps of 1 dB. The delay in milliseconds. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 37: Xconfiguration Audio Output Line [1] Delay Mode
Auto: The camera brightness is automatically set by the system. Manual: Enable manual control of the camera brightness. The brightness level is set using the Cameras Camera [n] Brightness DefaultLevel setting. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 38: Xconfiguration Cameras Camera [1] Brightness Defaultlevel
Manual: In manual mode the gamma value is changed with the gamma level setting, ref. Cameras Camera [n] Gamma Level. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 39: Xconfiguration Cameras Camera [1] Whitebalance Level
Off: Display the image as other people see you. On: Display the image as you see yourself in a mirror. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 40: Xconfiguration Cameras Preset Triggerautofocus
: Off/On Mute Off: The incoming call will not be muted. On: The incoming call will be muted when automatically answered. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 41: Xconfiguration Conference Autoanswer Delay
The number of minutes (maximum 1440 minutes = 24 hours) before the Do Not Disturb system cannot register, the auto-selection chooses H323. session times out automatically. H320: All calls are set up as H.320 calls (only applicable if connected to Cisco TelePresence ISDN Link). H323: All calls are set up as H.323 calls.
Page 42: Xconfiguration Conference Encryption Mode
On: Allows the far end to be able to select your video sources and control your local camera (pan, tilt, zoom). You will still be able to control your camera and select your video sources as normal. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 43: Xconfiguration Conference Maxtotalreceivecallrate
Requires user role: ADMIN Default value: 6000 USAGE: xConfiguration Conference MaxTotalTransmitCallRate: MaxTotalTransmitCallRate where : Integer (64..6000) MaxTotalTransmitCallRate The maximum transmit call rate (kbps). SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 44: H323 Configuration
H323 Gatekeeper Address must also be configured. xConfiguration H323 Authentication LoginName: "LoginName" where : String (0, 50) LoginName The authentication login name. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 45: Xconfiguration H323 Encryption Keysize
The H.323 Alias ID. Example: "firstname.lastname@company.com", "My H.323 Alias ID" : String (0, 255) Address A valid IPv4 address, IPv6 address or DNS name. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 46: Xconfiguration H323 Nat Mode
"My IP Address: 10.0.2.1". If the H323 NAT Address is wrong or not set, H.323 calls cannot be set up. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 47: Network Configuration
On: When set to On, the server-side X.509 certificate will be validated against the local CA-list for all TLS connections. Only servers with a valid certificate will be allowed. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 48: Xconfiguration Network [1] Ieee8021X Useclientcertificate
: Index that identifies the network. Range: 1..1 AnonymousIdentity The 802.1X Anonymous ID string. : String (0, 64) Identity The user name for 802.1X authentication. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 49: Xconfiguration Network [1] Ieee8021X Eap Md5
Define the Peap (Protected Extensible Authentication Protocol) mode. Authenticates LAN by Agere Systems, Proxim and Avaya. clients without the need for client certificates. Developed by Microsoft, Cisco and RSA Security. Requires user role: ADMIN, USER Requires user role: ADMIN, USER...
Page 50: Xconfiguration Network [1] Ipstack
Static: The addresses must be configured manually using the Network IPv4 Address, Network IPv4 Gateway and Network IPv4 SubnetMask settings (static addresses). DHCP: The system addresses are automatically assigned by the DHCP server. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 51: Xconfiguration Network [1] Ipv4 Subnetmask
DHCPv6 server. The Network IPv6 DHCPOptions setting determines which method to use. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 52: Xconfiguration Network [1] Ipv6 Dhcpoptions
Network MTU: where : Index that identifies the network. Range: 1..1 : Integer (576..1500) Set a value for the MTU (bytes). SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 53: Xconfiguration Network [1] Qos Diffserv Audio
Set the priority of the video packets in the IP network - the higher the number, the higher the priority. The default value is 0 (best effort). higher the priority. The default value is 0 (best effort). SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 54: Xconfiguration Network [1] Qos Diffserv Data
Set the priority of the signalling packets in the IP network - the higher the number, the higher the priority. The default value is 0 (best effort). SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 55: Xconfiguration Network [1] Qos Diffserv Ntp
RemoteAccess Allow: "Allow" where : Index that identifies the network. Range: 1..1 : String (0, 255) Allow A valid IPv4 address or IPv6 address. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 56: Xconfiguration Network [1] Speed
: Auto/Manual/Off Mode : Auto/10half/10full/100half/100full/1000full Speed Auto: The Cisco Discovery Protocol (CDP), if available, assigns an id to the voice VLAN. Auto: Autonegotiate link speed. If CDP is not available, VLAN is not enabled. 10half: Force link to 10 Mbps half-duplex.
Page 57: Networkservices Configuration
NetworkServices CDP Mode setting is switched Off, you cannot use the web interface. Enable or disable the CDP (Cisco Discovery Protocol) daemon. Enabling CDP will make the If you need extra security (encryption and decryption of requests, and pages that are returned endpoint report certain statistics and device identifiers to a CDP-enabled switch.
Page 58: Xconfiguration Networkservices Https Stricttransportsecurity
NTP Server [n] Address setting for time reference. Off: The system will not use an NTP server. The NetworkServices NTP Server [n] Address setting will be ignored. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 59: Xconfiguration Networkservices Ntp Server [1..3] Address
: Identifies the SNMP host. Maximum three SNMP hosts are allowed. Range: 1..3 : String (0, 255) Address A valid IPv4 address, IPv6 address or DNS name. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 60: Xconfiguration Networkservices Snmp Communityname
Requires user role: ADMIN in order to receive a response from the SNMP Agent in the codec. The default password is "public". If you have the Cisco TelePresence Management Suite (TMS) you must make sure the Default value: "" same SNMP Community is configured there too. NOTE: The SNMP Community password is case sensitive.
Page 61: Xconfiguration Networkservices Telnet Mode
IP address manually in order to pair a Touch controller to the video system. On: UPnP is enabled. The video system advertises its presence until the timeout period expires. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 62: Peripherals Configuration
Peripherals Profile TouchPanels Define the number of Cisco Touch controllers that are expected to be connected to the video system. This information is used by the video system's diagnostics service. If the number of connected Touch controllers does not match this setting, the diagnostics service will report it as an inconsistency.
Page 63: Phonebook Configuration
CUCM: The phonebook is located on the Cisco Unified Communications Manager. Spark: The phonebook is located on Spark. TMS: The phonebook is located on the Cisco TelePresence Management Suite server. VCS: The phonebook is located on the Cisco TelePresence Video Communication Server.
Page 64: Provisioning Configuration
Spark: Push configurations to the video system from Spark. TMS: Push configurations to the video system from TMS (Cisco TelePresence Management System). VCS: Push configurations to the video system from VCS (Cisco TelePresence Video Communication Server). SX20 Codec API Reference Guide CE9.1, JUNE 2017.
Page 65: Xconfiguration Provisioning Loginname
Default value: "" USAGE: xConfiguration Provisioning ExternalManager Address: "Address" where : String (0, 64) Address A valid IPv4 address, IPv6 address or DNS name. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 66: Xconfiguration Provisioning Externalmanager Alternateaddress
Provisioning ExternalManager AlternateAddress xConfiguration Provisioning ExternalManager Path Only applicable when the endpoint is provisioned by Cisco Unified Communication Manager Define the Path to the external manager / provisioning system. This setting is required when (CUCM) and an alternate CUCM is available for redundancy. Define the address of the alter- several management services reside on the same server, i.e.
Page 67: Proximity Configuration
Requires user role: ADMIN, USER video system. In order to use a client, at least one of the Proximity services must be enabled Default value: Enabled (refer to the Proximity Services settings). In general, Cisco recommends enabling all the Proximity services. USAGE:...
Page 68: Roomanalytics Configuration
Default value: 38400 USAGE: xConfiguration SerialPort BaudRate: BaudRate where : 9600/19200/38400/57600/115200 BaudRate Set a baud rate from the baud rates listed (bps). SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 69: Xconfiguration Serialport Loginrequired
Requires user role: ADMIN Default value: "" USAGE: xConfiguration SIP Authentication Password: "Password" where : String (0, 128) Password A valid password. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 70: Xconfiguration Sip Ice Mode
Rflx: Send media to the video system's public IP address, as seen by the TURN server. Relay: Send media to the IP address and port allocated on the TURN server. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 71: Xconfiguration Sip Listenport
Requires user role: ADMIN Default value: "" USAGE: xConfiguration SIP Turn Password: "Password" where : String (0, 128) Password A valid password. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 72: Xconfiguration Sip Uri
Requires user role: ADMIN, INTEGRATOR Default value: 10 USAGE: xConfiguration Standby Delay: Delay where : Integer (1..480) Delay Set the standby delay (minutes). SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 73: Xconfiguration Standby Bootaction
: None/PrivacyPosition StandbyAction None: No action. PrivacyPosition: When the video system enters standby, the camera turns to a sideways position for privacy. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 74: Systemunit Configuration
DD_MM_YY: The date January 30th 2010 will be displayed: 30.01.10 MM_DD_YY: The date January 30th 2010 will be displayed: 01.30.10 YY_MM_DD: The date January 30th 2010 will be displayed: 10.01.30 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 75: Xconfiguration Time Zone
Vincennes, America/Indiana/Winamac, America/Indianapolis, America/Inuvik, America/ Queensland, Australia/South, Australia/Sydney, Australia/Tasmania, Australia/Victoria, Iqaluit, America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, America/Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 76: Userinterface Configuration
Michigan, US/Mountain, US/Pacific, US/Pacific-New, US/Samoa, UTC, Universal, W-SU, DisplayName: Show the system's display name (refer to the SIP DisplayName setting). WET, Zulu Select a time zone from the list. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 77: Xconfiguration Userinterface Keytones Mode
: Arabic/Catalan/ChineseSimplified/ChineseTraditional/Czech/Danish/Dutch/ Language English/EnglishUK/Finnish/French/FrenchCanadian/German/Hebrew/Hungarian/Italian/ Japanese/Korean/Norwegian/Polish/Portuguese/PortugueseBrazilian/Russian/Spanish/ SpanishLatin/Swedish/Turkish Select a language from the list. Arabic and Hebrew are not supported in this software version. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 78: Usermanagement Configuration
STARTTLS: Connect to LDAP server on port 389, then send STARTTLS to enable TLS xConfiguration UserManagement LDAP Server Address: "Address" encryption. where : String (0, 255) Address A valid IPv4 address, IPv6 address or hostname. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 79: Xconfiguration Usermanagement Ldap Minimumtlsversion
Use the video system’s web interface to manage the list of trusted CAs (see more details in the administrator guide). SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 80: Xconfiguration Usermanagement Ldap Attribute
: Unique ID that identifies the video input connector. Range: 1..2 : Connector 1: Off/On Connector 2: Off Mode Off: Disable camera control. On: Enable camera control. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 81: Xconfiguration Video Input Connector [1
DVI-I cables with both analog and digital pins and AutoDetect fails. AnalogYPbPr: Set to AnalogYPbPr to force the DVI video input to AnalogYPbPr, as the component (YPbPr) signal cannot be auto detected. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 82: Xconfiguration Video Input Connector [1..2] Quality
(for example when a connected computer wakes up from sleep mode). Otherwise, the behavior is the same as in manual mode. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 83: Xconfiguration Video Input Connector [1..2] Visibility
DualPresentationOnly: All participants in the call are shown on the monitor with monitor role First. If a presentation is part of the layout, the presentation is shown on the monitor with monitor role Second. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 84: Xconfiguration Video Output Connector [1..2] Cec Mode
PresentationOnly: Show presentation video stream if active, and nothing else. Monitors/ Off: CEC is disabled. outputs with this monitor role are disregarded by the Video Monitors setting. On: CEC is enabled. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 85: Xconfiguration Video Output Connector [1..2] Overscanlevel
Default value: 2 USAGE: xConfiguration Video Presentation DefaultSource: DefaultSource where : 1/2/3 DefaultSource The video input source to use as default presentation source. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 86: Xconfiguration Video Selfview Default Mode
PiP during the call, it remains a PiP after the call; if it was fullscreen during the call, it remains fullscreen after the call. On: The self-view picture will be shown in fullscreen. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 87: Xconfiguration Video Selfview Default Pipposition
: Integer (1..60) Duration Range: Choose for how long self-view remains on. The valid range is between 1 and 60 seconds. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 88: Xcommand Commands
Cisco TelePresence SX20 Codec API Reference Guide  Introduction About the API xConfiguration xCommand xCommand xStatus Appendices Chapter 4 xCommand commands SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 89: Description Of The Xcommand Commands
Camera PositionSet ......................101 Call commands ............................. 96 xCommand Camera Preset Activate ......................102 xCommand Call Accept ..........................96 xCommand Camera Preset ActivateDefaultPosition ................102 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 90 Security Persistency ......................118 xCommand Security Session List ......................118 Phonebook commands ........................110 xCommand Security Session Terminate ....................119 xCommand Phonebook Contact Add ....................... 110 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 91 UserInterface Message Alert Display ...................124 xCommand Video PresentationView Set ....................132 xCommand UserInterface Message Prompt Clear ..................124 xCommand Video Selfview Set ........................132 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 92: Audio Commands
: Integer (1..50) Volume The volume for the test signal. In a noisy environment a higher volume gives more reliable and robust results. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 93: Xcommand Audio Sound Play
Audio SoundsAndAlerts Ringtone List : Integer (1..10) Steps Choose the number of steps to increase the volume with. One step is 0.5 dB. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 94: Xcommand Audio Volume Mute
Audio Volume SetToDefault xCommand Audio Volume ToggleMute Toggle the loudspeaker between muted and unmuted. Requires user role: ADMIN, USER USAGE: xCommand Audio Volume ToggleMute SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 95: Xcommand Audio Vumeter Stop
: String (0, 128) Requires user role: ADMIN, USER The booking ID of a call or conference. USAGE: xCommand Audio VuMeter StopAll SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 96: Xcommand Call Disconnect
The CallID is returned when the xCommand Dial command is run. During the call you can run the xStatus Call command to see the CallId. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 97: Xcommand Call Dtmfsend
Call command to see the CallId. : Integer (1..15) PresetId The ID of the preset that is stored on the far end codec. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 98: Xcommand Call Farendcontrol Source Select
Call Join CallId: CallId where : Integer (0..65534) CallId You can have from 1 to 10 CallId parameters in the same command. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 99: Xcommand Call Reject
Call command to see the CallId. You can filter which calls to delete. : String (0, 255) Number The number the call is transfered to. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 100: Xcommand Callhistory Deleteentry
Allows you to set the command to apply to a specified display name or call back number. : Integer (0..65534) CallHistoryId CallHistoryId for the call in question. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 101: Xcommand Callhistory Recents
Move the camera to the left or right. : Integer (-2500..2500) Tilt Move the camera up or down. : Integer (0..8500) Zoom Zoom in or out. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 102: Xcommand Camera Preset Activate
The ID of the camera preset you want to activate. If CameraId is not specified, all cameras will be set in their respective default position, if one is defined. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 103: Xcommand Camera Preset List
USAGE: xCommand Camera Preset Remove PresetId: PresetId where : Integer (1..35) PresetId The ID of the camera preset you want to remove. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 104: Xcommand Camera Preset Store
Note that each camera can hold only one default position, so if set, the old default preset will automatically be marked as not default. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 105: Xcommand Camera Triggerautofocus
Releases locked speaker set by xCommand Conference SpeakerLock Set. Default voice switching is switched back on. Requires user role: ADMIN, USER USAGE: xCommand Conference SpeakerLock Release SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 106: Xcommand Conference Speakerlock Set
You can filter the diagnostics results to alerts, all or none. If not set, the result will show Identify CallID for the remote participant. Only relevant if Target is set to "remote". all results. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 107: Dial Commands
: Integer (1..999999999) Appearance Internal usage only. : String (0, 255) DisplayName The display name of the remote participant. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 108: Xcommand Httpfeedback Register
Requires user role: ADMIN, INTEGRATOR, ROOMCONTROL, USER registering to one of them. USAGE: Note: Avoid using FeedbackSlot 3 in an environment where Cisco TelePresence Management Suite (TMS) is used as TMS uses this feedbackslot to register its xCommand Peripherals Connect [HardwareInfo: "HardwareInfo"] ID: "ID" [Name: expressions.
Page 109: Xcommand Peripherals Heartbeat
Enter the MAC address for the ISDN Link you wish to pair to the endpoint. Limit the search to currently connected devices. : All/ControlSystem/ISDNLink/Other/TouchPanel Type Limit the search by device type. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 110: Xcommand Peripherals Pairing Unpair
You can add several contact methods to a contact using the xCommand Phonebook where ContactMethod Add command. Note that only the first contact method will appear in the Favorites list on the Cisco TelePresence Touch controller. All contact methods are available in : String (1, 100) MacAddress the API, on the web interface and when using the remote control.
Page 111: Xcommand Phonebook Contact Delete
: String (0, 255) Title The title of the contact. : Untagged/Favorite Tag the contact as a Favorite, or untag an already tagged contact. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 112: Xcommand Phonebook Contactmethod Add
You can add several contact methods to a contact. Note that only the first contact method USAGE: will appear in the Favorites list on the Cisco TelePresence Touch controller. The first contact xCommand Phonebook ContactMethod Delete ContactId: "ContactId" ContactMethodId: method may have been created when issuing the xCommand Phonebook Contact Add "ContactMethodId"...
Page 113: Xcommand Phonebook Contactmethod Modify
Set a call rate. Add command was issued to make the folder. : Audio/Video CallType Select a call type (audio or video). SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 114: Xcommand Phonebook Folder Modify
10, the ResultSet will contain only 10 entries (Contacts and Folders) even if the total number of hits is larger. The maximum limit is 1000. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 115: Presentation Commands
Select which local presentation you wish to stop, identified by presentation instance. : Integer (1..2) PresentationSource Select which local presentation you wish to stop, identified by source number. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 116: Provisioning Commands
This command will log you out of your Extension Mobility profile. Requires user role: ADMIN, USER Requires user role: ADMIN, USER USAGE: USAGE: xCommand Provisioning StartUpgrade xCommand Provisioning ExtensionMobility Logout SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 117: Proximity Commands
Requires user role: ADMIN, USER USAGE: xCommand RoomPreset Clear PresetId: PresetId where : Integer (1..15) PresetId The ID of the preset you want to delete. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 118: Xcommand Roompreset Store
: Yes ConfirmAndReboot Reboots the system. xCommand Security Session List List active sessions. Requires user role: ADMIN, USER USAGE: xCommand Security Session List SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 119: Xcommand Security Session Terminate
Requires user role: ADMIN, USER USAGE: xCommand Standby ResetTimer Delay: Delay where : Integer (1..480) Delay Set the delay in minutes. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 120: Systemunit Commands
Network 1 xConfiguration NetworkServices Wifi Allowed xConfiguration NetworkServices Wifi Enabled Spark: xConfiguration Spark ServiceOverrides GdsBaseUrl xConfiguration Spark ServiceOverrides U2CBaseUrl xConfiguration Spark ServiceOverrides WdmBaseUrl SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 121: Xcommand Systemunit Firsttimewizard Stop
Clears the list of system notifications that are reported by xStatus SystemUnit Notifications xCommand SystemUnit OptionKey Remove Type: Type Text/Type. where Requires user role: ADMIN : MultiSite/RemoteMonitoring Type USAGE: xCommand SystemUnit Notifications RemoveAll SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 122: Xcommand Systemunit Optionkey Removeall
Banner text <enter> . <enter> Requires user role: ADMIN USAGE: xCommand SystemUnit SignInBanner Set SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 123: Time Commands
: Integer (0..23) Hour : String (0, 40) ConfigId The unique identifier for the configuration. : Integer (0..59) Minute : Integer (0..59) Second SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 124: Xcommand Userinterface Extensions Widget Setvalue
: String (0, 255) FeedbackId xCommand UserInterface Message Alert Clear The FeedbackId corresponds to the FeedbackId given by the xCommand Message Prompt Display command. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 125: Xcommand Userinterface Message Prompt Display
Enter the text to appear on the feedback options. : String (0, 255) Option.5 Enter the text to appear on the feedback options. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 126: Xcommand Userinterface Message Textline Display
Requires user role: ADMIN USAGE: xCommand UserInterface OSD Key Click Key: where : 0/1/2/3/4/5/6/7/8/9/C/Call/Disconnect/Down/F1/F2/F3/F4/F5/Grab/Home/Layout/Left/ Mute/MuteMic/Ok/PhoneBook/Presentation/Right/Selfview/Square/SrcAux/SrcCamera/ SrcDocCam/SrcPc/SrcVcr/Star/Up/VolumeDown/VolumeUp/ZoomIn/ZoomOut/+/- Define the remote key to press. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 127: Xcommand Userinterface Presentation Externalsource Add
The unique string that identifies this input source. It was defined when the source was created with the UserInterface Presentation ExternalSource Add command. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 128: Xcommand Userinterface Presentation Externalsource State Set
Disable the creation of new remote support users. To enable the remote support user again you must factory reset your system. Requires user role: ADMIN USAGE: xCommand UserManagement RemoteSupportUser DisablePermanently Confirm: Confirm where : Yes Confirm SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 129: Xcommand Usermanagement Remotesupportuser Getstate
: String (0, 255) xCommand UserManagement User Passphrase Change NewPassphrase: "NewPassphrase" YourPassphrase OldPassphrase: "OldPassphrase" where : String (0, 255) NewPassphrase : String (0, 255) OldPassphrase SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 130: Video Commands
The identifier (ID) of the input source. Input Source [n] has ID n. Run the following API command to find the ID: xStatus Video Input Source. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 131: Xcommand Video Matrix Assign
The identifier (ID) of the input source. Input Source [n] has ID n. Run the following API Choose the output you want to reset. command to find the ID: xStatus Video Input Source. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 132: Xcommand Video Presentationpip Set
Select Maximized when you want the presentation to be displayed in full screen. Select Minimized when you want the presentation to be displayed in a small picture on screen. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 133: Xstatus Commands
Cisco TelePresence SX20 Codec API Reference Guide  Introduction About the API xConfiguration xCommand xStatus xStatus Appendices Chapter 5 xStatus commands SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 134: Description Of The Xstatus Commands
Capabilities Conference MaxActiveCalls ..................147 xStatus Call [n] FacilityServiceId .......................143 xStatus Capabilities Conference MaxAudioCalls ..................147 xStatus Call [n] HoldReason ........................143 xStatus Capabilities Conference MaxCalls ....................147 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 135 Diagnostics Message [n] Type .....................153 xStatus MediaChannels Call [n] Channel [n] Video ResolutionY ...............160 H323 status ............................154 Network status ............................ 160 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 136 SIP AlternateURI Alias [n] URI ......................172 xStatus Peripherals ConnectedDevice [n] Status ..................166 xStatus SIP AlternateURI Primary [n] URI ....................172 xStatus Peripherals ConnectedDevice [n] Type ..................166 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 137 Video Input Source [n] Resolution Width ..................184 xStatus SystemUnit Software OptionKeys RemoteMonitoring ..............179 xStatus Video Layout LayoutFamily Local ....................184 xStatus SystemUnit Software ReleaseDate .....................179 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 138 Video Presentation PIPPosition ....................188 xStatus Video Selfview FullscreenMode ....................188 xStatus Video Selfview Mode ........................188 xStatus Video Selfview OnMonitorRole ....................188 xStatus Video Selfview PIPPosition ......................188 SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 139: Audio Status
Requires user role: ADMIN, INTEGRATOR, USER Value space of the result returned: On/Off Example: xStatus Audio Microphones Mute *s Audio Microphones Mute: Off ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 140: Xstatus Audio Output Connectors Line [N] Delayms
Requires user role: ADMIN, INTEGRATOR, USER Value space of the result returned: 0..100 Example: xStatus Audio Volume *s Audio Volume: 70 ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 141: Bookings Status
Requires user role: ADMIN, USER Value space of the result returned: String Example: xStatus Call 27 CallbackNumber *s Call 27 CallbackNumber: "h323:firstname.lastname@company.com" ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 142: Xstatus Call [N] Calltype
Call [n] DeviceType xStatus Call [n] Duration Indicates whether the remote system is a single endpoint or an MCU. Some Cisco endpoints Shows the duration of a call (in seconds). You can run the command xStatus Call to find the call (SX20, SX80, MX200 G2, MX300 G2) have built-in MCU capabilities.
Page 143: Xstatus Call [N] Placedonhold
Requires user role: ADMIN, INTEGRATOR, USER Value space of the result returned: Integer Example: xStatus Call 27 ReceiveCallRate *s Call 27 ReceiveCallRate: 4000 ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 144: Xstatus Call [N] Remotenumber
Call 27 TransmitCallRate xStatus Cameras Camera 1 Flip *s Call 27 TransmitCallRate: 768 *s Camera 1 Flip: "Off" ** end ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 145: Xstatus Cameras Camera [N] Hardwareid
Cameras Camera 1 Manufacturer xStatus Cameras Camera 1 Position Pan *s Camera 1 Manufacturer: "Cisco" *s Camera 1 Position Pan: 412 ** end ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 146: Xstatus Cameras Camera [N] Position Tilt
Requires user role: ADMIN, INTEGRATOR, USER, ROOMCONTROL Value space of the result returned: String Example: xStatus Cameras Camera 1 SerialNumber *s Camera 1 SerialNumber: "B1AB26B00010" ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 147: Capabilities Status
Requires user role: ADMIN, USER Value space of the result returned: 0..5 Example: xStatus Capabilities Conference MaxCalls *s Capabilities Conference MaxCalls: 3 ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 148: Conference Status
*s Conference Call 2 Capabilities FECC NumberOfSources: 5 xStatus Conference Call Capabilities FarendMessage Mode ** end *s Conference Call 4 Capabilities FarendMessage Mode: Off ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 149: Xstatus Conference Call [N] Capabilities Fecc Source [N] Name
Conference Call 2 Capabilities FECC Source 1 SourceId *s Conference Call 2 Capabilities Presentation: True *s Conference Call 2 Capabilities FECC Source 1 SourceId: 6 ** end ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 150: Xstatus Conference Call [N] Manufacturer
Requires user role: ADMIN, USER Value space of the result returned: String Example: xStatus Conference Call 2 SoftwareID *s Conference Call 2 SoftwareID: "CE8" ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 151: Xstatus Conference Multipoint Mode
Value space of the result returned: *s Conference Presentation CallId: 0 On/Off ** end Example: xStatus Conference Presentation Mode *s Conference Presentation Mode: Off ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 152: Xstatus Conference Speakerlock Callid
Requires user role: ADMIN, USER Value space of the result returned: Error/Warning/Critical Example: xStatus Diagnostics Message 4 Level *s Diagnostics Message 4 Level: Warning ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 153: Xstatus Diagnostics Message [N] References
VideoFromInternalCamera/VideoInputStability/VideoInputSignalQuality/SparkConnectivity/ SpeakerTrackFrontPanelMountedCorrectly/SpeakerTrackMicrophoneConnection/ SpeakerTrackVideoInputs/SpeakerTrackEthernetConnection/ANATOnVCS/ ECReferenceDelay/AudioECRefDelay/AudioPairingNoise/AudioPairingRate/AudioPairingSNR/ AudioPairingInterference/AudioPairingTokenDecode/AudioInternalSpeakerDisabled/ AbnormalCallTermination/HasActiveCallProtocol/SipOrH323ButNotBothEnabled/ PresentationSourceSelection/SoftwareUpgrade/PlatformSanity/ContactInfoMismatch/ MicrophoneReinforcement/FirstTimeWizardNotCompleted/CaptivePortalDetected/ MonitorDelay/WifiCARequired Example: xStatus Diagnostics Message Type *s Diagnostics Message 1 Type: CamerasDetected ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 154: Xstatus H323 Gatekeeper Address
Requires user role: ADMIN, USER Value space of the result returned: String Example: xStatus H323 Gatekeeper Reason *s H323 Gatekeeper Reason: "" ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 155: Xstatus H323 Mode Status
Requires user role: ADMIN, USER Value space of the result returned: String Example: xStatus HttpFeedback 1 URL *s HttpFeedback 1 URL: "http://tms.company.com/tms/public/feedback/code.aspx" ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 156: Mediachannels Status
*s MediaChannels Call 27 Channel 327 Audio Protocol: AACLD *s MediaChannels Call 27 Channel 327 Audio Mute: False ** end ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 157: Xstatus Mediachannels Call [N] Channel [N] Direction
*s MediaChannels Call 27 Channel 327 NetStat LastIntervalLost: 0 *s MediaChannels Call 27 Channel 327 NetStat Bytes: 496640 ** end ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 158: Xstatus Mediachannels Call [N] Channel [N] Netstat Lastintervalreceived
Value space of the result returned: Integer Example: xStatus MediaChannels Call 27 Channel 327 NetStat MaxJitter *s MediaChannels Call 27 Channel 327 NetStat MaxJitter: 2 ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 159: Xstatus Mediachannels Call [N] Channel [N] Type
Value space of the result returned: H261/H263/H263p/H263pp/H264/HEVC/JPEG/MP4V/Off Example: xStatus MediaChannels Call 27 Channel 327 Video Protocol *s MediaChannels Call 27 Channel 327 Video Protocol: H264 ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 160: Xstatus Mediachannels Call [N] Channel [N] Video Resolutionx
Requires user role: ADMIN, USER Value space of the result returned: String Example: xStatus Network CDP DeviceId *s Network 1 CDP DeviceId: "123456.company.com" ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 161: Xstatus Network 1 Cdp Duplex
Network CDP PortID xStatus Network CDP SysObjectID *s Network 1 CDP PortID: "GigabitEthernet1/0/23" *s Network 1 CDP SysObjectID: "" ** end ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 162: Xstatus Network 1 Cdp Version
Example: xStatus Network 1 CDP Version xStatus Network 1 DNS Domain Name *s Network 1 CDP Version: "Cisco IOS Software, C3560CX Software (C3560CX- *s Network 1 DNS Domain Name: "www.example.com www.example.int" UNIVERSALK9-M), Version 15.2(3)E, RELEASE SOFTWARE (fc4)*Technical Support: ** end http://www.cisco.com/techsupport*Copyright (c) 1986-2014 by Cisco Systems,...
Page 163: Xstatus Network 1 Ethernet Speed
Network 1 IPv4 Gateway xStatus Network 1 IPv6 Gateway *s Network 1 IPv4 Gateway: "192.0.2.10" *s Network 1 IPv6 Gateway: "" ** end ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 164: Xstatus Network 1 Vlan Voice Vlanid
Requires user role: ADMIN, USER Value space of the result returned: String Example: xStatus NetworkServices NTP Address *s NetworkServices NTP Address: "12.104.193.12 64.104.222.16 144.254.15.121" ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 165: Xstatus Networkservices Ntp Status
Value space of the result returned: String Example: xStatus Peripherals ConnectedDevice 1007 Name *s Peripherals ConnectedDevice 1007 Name: "Cisco TelePresence Touch" ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 166: Xstatus Peripherals Connecteddevice [N] Upgradestatus
Requires user role: ADMIN, INTEGRATOR, USER, ROOMCONTROL Value space of the result returned: Byod/Camera/ControlSystem/ISDNLink/Other/SpeakerTrack/TouchPanel Example: xStatus Peripherals ConnectedDevice 1001 Type *s Peripherals ConnectedDevice 1001 Type: TouchPanel ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 167: Provisioning Status
Value space of the result returned: String Example: xStatus Provisioning Software Current URL *s Provisioning Software Current URL: "http://.../s52020ce8 _ 0 _ 0.pkg" ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 168: Xstatus Provisioning Software Current Versionid
Example: *s Provisioning Software UpgradeStatus Message: "" xStatus Provisioning Software UpgradeStatus Status ** end *s Provisioning Software UpgradeStatus Status: None ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 169: Xstatus Provisioning Software Upgradestatus Url
Value space of the result returned: ** end String Example: xStatus Provisioning Software UpgradeStatus VersionId *s Provisioning Software UpgradeStatus VersionId: "s52010ce8 _ 0 _ 0.pkg" ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 170: Proximity Status
Example: Example: xStatus RoomAnalytics PeoplePresence xStatus Proximity Services Availability *s RoomAnalytics PeoplePresence: No *s Proximity Services Availability: Disabled ** end ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 171: Security Status
Requires user role: ADMIN, USER Value space of the result returned: NonPersistent/Persistent Example: xStatus Security Persistency InternalLogging *s Security Persistency InternalLogging: Persistent ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 172: Xstatus Security Persistency Localphonebook
Requires user role: ADMIN, USER Value space of the result returned: Digest/Off Example: xStatus SIP Authentication *s SIP Authentication: Off ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 173: Xstatus Sip Callforward Displayname
SIP CallForward URI xStatus SIP Proxy 1 Address *s SIP CallForward URI: "" *s SIP Proxy 1 Address: "192.0.2.50" ** end ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 174: Xstatus Sip Proxy [N] Status
** end Value space of the result returned: Digest/Off Example: xStatus SIP Registration 1 Authentication *s SIP Registration 1 Authentication: Off ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 175: Xstatus Sip Registration [N] Uri
Shows whether or not the SSL certificate of the server that the video system / codec tries to register to is included in the codec’s trusted CA-list. The server is typically a Cisco VCS or Requires user role: ADMIN, USER CUCM.
Page 176: Standby Status
SystemUnit Hardware Module CompatibilityLevel Shows whether the system is in standby mode or not. The Cisco TelePresence endpoints are using a NAND flash memory for general storage. The endpoints running TC software are manufactured with a new version of the flash memory.
Page 177: Xstatus Systemunit Hardware Monitoring Fan [N] Status
*s SystemUnit ProductId: "Cisco TelePresence Codec SX80" String ** end Example: xStatus SystemUnit Notifications Notification 1 Text *s SystemUnit Notifications Notification 1 Text: "OK" ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 178: Xstatus Systemunit Productplatform
SystemUnit Software DisplayName xStatus SystemUnit Software OptionKeys MultiSite *s SystemUnit Software DisplayName: "Display Name" *s SystemUnit Software OptionKeys MultiSite: "true" ** end ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 179: Xstatus Systemunit Software Version
SystemUnit State NumberOfSuspendedCalls xStatus SystemUnit Software Version *s SystemUnit State NumberOfSuspendedCalls: 0 *s SystemUnit Software Version: "CE8.0.0" ** end ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 180: Xstatus Systemunit Uptime
Value space of the result returned: xStatus SystemUnit Uptime String *s SystemUnit Uptime: 597095 Example: ** end xStatus Time SystemTime *s Time SystemTime: "2014-04-25T10:04:03Z" ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 181: Usb Status
The value is an empty string until a value is set with the UserInterface Extensions Widget SetValue command. Requires user role: ADMIN, INTEGRATOR, USER, ROOMCONTROL Value space of the result returned: String SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 182: Xstatus Userinterface Extensions Widget [N] Widgetid
Value space of the result returned: False/True/Unknown Example: xStatus Video Input Connector 1 Connected *s Video Input Connector 1 Connected: True ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 183: Xstatus Video Input Connector [N] Signalstate
*s Video Input Source 1 Resolution FormatStatus: Ok Example: ** end xStatus Video Input Connector 1 Type *s Video Input Connector 1 Type: HDMI ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 184: Xstatus Video Input Source [N] Formattype
*s Video Layout LayoutFamily Local: "equal" xStatus Video Input Source 1 Resolution Height ** end *s Video Input Source 1 Resolution Height: 1080 ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 185: Xstatus Video Layout Layoutfamily Remote
Video Output Connector 1 ConnectedDevice CEC DeviceType *s Video Monitors: Single *s Video Output Connector 1 ConnectedDevice CEC DeviceType: TV ** end ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 186: Xstatus Video Output Connector [N] Connecteddevice Cec Name
Value space of the result returned: String Example: xStatus Video Output Connector 1 ConnectedDevice Name *s Video Output Connector 1 ConnectedDevice Name: "G2420HDBL" ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 187: Xstatus Video Output Connector [N] Connecteddevice Preferredformat
Value space of the result returned: ** end 176..4000 Example: xStatus Video Output Connector 1 Resolution Width *s Video Output Connector 1 Resolution Width: 1920 ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 188: Xstatus Video Output Connector [N] Type
Video Selfview PIPPosition *s Video Selfview PIPPosition: LowerRight Example: ** end xStatus Video Selfview FullscreenMode *s Video Selfview FullscreenMode: Off ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 189: Appendices
Cisco TelePresence SX20 Codec API Reference Guide  Introduction About the API xConfiguration xCommand xStatus Appendices Appendices Chapter 6 Appendices SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 190: About Startup Scripts
Use the codec’s web interface to create and manage startup scripts. Read more about the web interface and startup scripts in the Administrator guide for your product. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 191: The Systemtools Commands
<hostname> | netstat | addrs | ifconfig Max failed login attempts [0]? • Number of failed logins until a user is set inactive. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 192 Max consecutive equal digits in PINs [0]? • Maximum consecutive equal digits in PINs. Minimum number of digits in PINs [0]? • Minimum number of digits in PINs. SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 193: About Disconnect Cause Types
*h xHistory CallLogs Call 694 DisconnectCauseType: RemoteDisconnect *h xHistory CallLogs Call 694 DisconnectCauseCode: 16 *h xHistory CallLogs Call 694 DisconnectCauseOrigin: Q850 ** end SX20 Codec API Reference Guide CE9.1, JUNE 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved. D15316.07...
Page 194: User Documentation On The Cisco Web Site
Release Notes • Administering CE Endpoints on CUCM: Tasks to • Software release notes perform to start using the product with the Cisco Unified Communications Manager (CUCM) Maintain and Operate > End-User Guides • User guides: How to use the product •...
Page 195 Tandberg ASA. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company.

Cisco TelePresence SX20 Codec Reference Manual

Quick Links

Related Manuals for Cisco TelePresence SX20 Codec

Summary of Contents for Cisco TelePresence SX20 Codec