Cisco TelePresence MX700 Reference Manual Download Page 32

Page: 32 / 241

D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.

Cisco TelePresence MX700 and MX800

API Reference Guide

Terminal connections

Managing feedback subscriptions

To register, list and deregister feedback expressions you

use the command xFeedback and its corresponding sub

commands.

The registered expressions are only valid for the currently

active connection. If you open two Telnet sessions and

feedback in the other session. This also means that if you

disconnect from a session, you have to re-register all

expressions after reconnecting.

You can register up to 38 expressions.

Feedback output

The feedback output is exactly the same as you get when

querying the system using the xConfiguration and xStatus

commands. E.g., if you issue the command

xStatus Standby

Active

on the command line the result is:

*s Standby Active: On

** end

If you have registered for feedback on status changes the

feedback you get when the system goes to standby-mode

will be exactly the same:

*s Standby Active: On

** end

This means that when you are programming against the

device you only need to handle one format.

Example: Managing feedback subscriptions

Write in:

xFeedback register /Status/Audio

Result:

** end

Write in:

xFeedback register /Event/CallDisconnect

Result:

** end

Write in:

xFeedback register /Configuration/Video/

MainVideoSource

Result:

** end

List out currently registered expressions.

Write in:

xFeedback list

Result:

/Configuration/Video/MainVideoSource

/Event/CallDisconnect

/Status/Audio

** end

Deregister feedback expressions.

Write in:

xFeedback deregister /Event/CallDisconnect

Result:

** end

Write in:

xFeedback deregister /Status/Audio

Result:

** end

List the new feedback expressions.

Write in:

xFeedback list

Result:

/Configuration/Video/MainVideoSource

** end

Introduction

About the API

xConfiguration

Appendices

xCommand

xStatus



About the API

Summary of Contents for TelePresence MX700

Page 1: ...isco Systems Inc All rights reserved 1 Cisco TelePresence MX700 and MX800 API Reference Guide Collaboration Endpoint Software 9 2 NOVEMBER 2017 Application Programming Interface API Reference Guide Cisco TelePresence MX700 and MX800 Introduction About the API xConfiguration Appendices xCommand xStatus ...

Page 2: ...tput modes 24 Using the command line 25 API commands 25 Other commands 25 Command line shortcuts 26 Searching 26 Value types and formats 26 Commands 27 Configurations 27 Status 27 Multiline commands 28 Synchronous API calls 29 Events 30 Feedback mechanism 31 Feedback expressions 31 Terminal connections 32 HTTP XMLAPI Authentication 33 HTTP XMLAPI Session Authentication 33 Getting status and config...

Page 3: ...Reference Guide CE9 2 NOVEMBER 2017 Copyright 2017 Cisco Systems Inc All rights reserved 3 Cisco TelePresence MX700 and MX800 API Reference Guide Chapter 1 Introduction Introduction About the API xConfiguration Appendices xCommand xStatus Introduction ...

Page 4: ...tered video systems CUCM VCS as well as video systems registered to Cisco s cloud service Cisco Spark For Cisco Spark registered systems only a subset of the API is available and the user role integrator and roomcontrol of the local user determines which commands are available Downloading the user documentation You can download the user documentation from the Cisco web site go to http www cisco co...

Page 5: ...e far end in a call Source composition can only be enabled via the API so we recommend creating a user interface extension combined with a macro to control the compositions on demand This feature replaces some of the functionality that was provided by the TC Console application for TC software HTTP Proxy support You can set up the video system to go through a HTTP Proxy when registering it to Cisc...

Page 6: ... CA Add or xCommand Security Ceritifcates Services Add You can also upload certificates to a video system from its web interface as before API commands for user management You can create and manage user accounts directly using API commands xCommand UserManagement User As before you can also do this from the video system s user interface Preview mode for In Room Controls The In Room Control editor ...

Page 7: ...TP Proxy Password NetworkServices HTTP Proxy Url Standby WakeupOnMotionDetection UserInterface CustomMessage UserInterface OSD HalfwakeMessage UserInterface SettingsMenu Mode Configurations that are removed None Configurations that are modified Cameras Camera n Focus Mode OLD Value space Auto Manual NEW Value space Auto AutoLimited Manual Cameras SpeakerTrack Closeup OLD User role ADMIN INTEGRATOR...

Page 8: ...icates Services Activate Security Certificates Services Add Security Certificates Services Deactivate Security Certificates Services Delete Security Certificates Services Show Standby Halfwake SystemUnit ProductPlatform Set UserInterface Branding Delete UserInterface Branding Get UserInterface Branding Updated UserInterface Branding Upload UserInterface Extensions Widget Action UserInterface Messa...

Page 9: ... Play OLD User role INTEGRATOR USER NEW User role ADMIN INTEGRATOR USER Audio SpeakerCheck OLD Volume Integer 1 10 NEW Volume Integer 1 30 Call Disconnect OLD User role ADMIN USER NEW User role ADMIN INTEGRATOR USER Camera PositionReset OLD User role ADMIN USER NEW User role ADMIN INTEGRATOR USER Camera PositionSet OLD User role ADMIN USER NEW User role ADMIN INTEGRATOR USER Added Lens Wide Center...

Page 10: ... SystemUnit Boot OLD User role INTEGRATOR USER NEW User role ADMIN INTEGRATOR USER SystemUnit FirstTimeWizard Stop OLD User role INTEGRATOR USER NEW User role ADMIN INTEGRATOR USER UserInterface Extensions List OLD User role INTEGRATOR ROOMCONTROL USER NEW User role ADMIN INTEGRATOR ROOMCONTROL USER UserInterface Message Prompt Display Added Duration Integer 0 3600 Video Input SetMainVideoSource A...

Page 11: ...ra VideoInputConnector Cameras SpeakerTrack RightCamera VideoInputConnector Statuses that are modified Diagnostics Message n Type Removed from valuespace CamerasDetectedNoIr UdpPortRangeViolation Added to valuespace CameraDetected CertificateExpiry MacrosRuntimeStatus MediaPortRangeNegative MediaPortRangeOdd MediaPortRangeOverlap MediaPortRangeTooSmall MediaPortRangeValueSpace MicrophonesConnected...

Page 12: ...which leads to a calmer wake up of the system and gives users better guidance on how to get started When wake up on motion detection is enabled the system will automatically wake to the Halfwake state when people enter the room It will also wake to this state when a user pairs a Cisco Proximity client to the system Additions for Room Analytics Detect people presence in the room The video system ha...

Page 13: ... None Configurations that are modified Conference DefaultCal Rate OLD Default value 3072 NEW Default value 6000 Conference MultiStream Mode OLD Valuespace Off Default value Off NEW Valuespace Auto Off Default value Auto 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 Value...

Page 14: ...Set Commands that are removed None Commands that are modified Cameras SpeakerTrack Diagnostics Start OLD User role ADMIN INTEGRATOR NEW User role ADMIN USER Cameras SpeakerTrack Diagnostics Stop OLD User role ADMIN INTEGRATOR NEW User role ADMIN USER SystemUnit FactoryReset All products OLD Keep LocalSetup Network Spark Provisioning NEW Keep LocalSetup Network Spark Provisioning SerialPort Certifi...

Page 15: ...sentationSourceSelection SoftwareUpgrade PlatformSanity ContactInfoMismatch MicrophoneReinforcement FirstTimeWizardNotCompleted CaptivePortalDetected MonitorDelay NEW Value space CAPFOperationState CTLinstallation CUCMVendorConfigurationFile CallProtocolDualStackConfig CallProtocolIPStackPlatformCompatibility CallPr otocolVcsProvisioningCompatibility CameraId CameraPairing CameraSerial CameraSoftw...

Page 16: ...ce the system in standby when this feature is enabled Updated In Room Control Editor The In Room Control editor is updated with a new look improved logic and usability for producing a control interface more efficiently In addition a new directional pad widget and an In Room Control simulator is added Added language support We have added support for Potuguese Portugal to the on screen display and T...

Page 17: ...dio Input HDMI n Audio Input Line n Audio Input Microphone n Audio MicrophoneReinforcement Audio Microphones Mute Enabled Audio Output Line n Audio SoundsAndAlerts Cameras Camera n Cameras SpeakerTrack Conference DefaultCall Rate Conference DoNotDisturb DefaultTimeout GPIO Pin n Mode Peripherals Profile SerialPort BaudRate SerialPort Mode Standby BootAction Standby Control Standby Delay Standby St...

Page 18: ... Unmute Audio Sound Play Audio SoundsAndAlerts Ringtone List Audio SoundsAndAlerts Ringtone Play Audio Sound Stop Cameras AutoFocus Diagnostics Start Cameras AutoFocus Diagnostics Stop Cameras PresenterTrack ClearPosition Cameras PresenterTrack Set Cameras PresenterTrack StorePosition Cameras SpeakerTrack Diagnostics Start Peripherals Connect Peripherals List Standby Activate Standby Deactivate Sy...

Page 19: ...EthernetConnection ANATOnVCS ECReferenceDelay AudioECRefDelay AudioPairingNoise AudioPairingRate AudioPairingSNR AudioPairingInterference AudioPairingTokenDecode AudioInternalSpeakerDisabled AbnormalCallTermination HasActiveCallProtocol SipOrH323ButNotBothEnabled PresentationSourceSelection SoftwareUpgrade PlatformSanity ContactInfoMismatch MicrophoneReinforcement NEW CAPFOperationState CTLinstall...

Page 20: ...ectedDevice n Name Peripherals ConnectedDevice n SoftwareInfo Peripherals ConnectedDevice n Status Peripherals ConnectedDevice n Type Peripherals ConnectedDevice n UpgradeStatus Standby State SystemUnit State NumberOfActiveCalls SystemUnit State NumberOfInProgressCalls Time SystemTime UserInterface Extensions Widget n Value UserInterface Extensions Widget n WidgetId Video ActiveSpeaker PIPPosition...

Page 21: ...ference Guide CE9 2 NOVEMBER 2017 Copyright 2017 Cisco Systems Inc All rights reserved 21 Cisco TelePresence MX700 and MX800 API Reference Guide Chapter 2 About the API Introduction About the API xConfiguration Appendices xCommand xStatus About the API ...

Page 22: ...e admin user in order to restrict access to system configuration You should in addition set a password for any other user with similar credentials You can set the password on the codec s web interface Open a web browser and enter the IP address of the video system in the address bar and log in Click your user name in the upper right corner and choose Change password in the drop down menu SSH SSH i...

Page 23: ...ser roles A user account may hold one or a combination of user roles A user account with full access rights like the default admin user should possess the ADMIN USER and AUDIT roles These are the user roles ADMIN A user with this role can create new users change most settings make calls and search the contact lists The user cannot upload audit certificates and change the security audit settings US...

Page 24: ...ems XML XML output for use with control systems that understand XML JSON JSON format is convenient when integrating with web based systems The default output mode is terminal To change this you have to define your preferences for each session individually Examples in this guide are in terminal mode To set output mode to XML issue the command xPreferences outputmode xml To revert to terminal mode i...

Page 25: ...ack is only issued on the RS 232 Telnet or SSH session for which it is specified If you are connecting to the codec with multiple sessions you have to define feedback individually for each session Refer to Feedback mechanism on page 31 xPreferences The xPreferences command is used to set preferences for the RS 232 Telnet and SSH sessions Refer to API output on page 24 Echo on off If echo is set to...

Page 26: ...all connected sources for both inputs and outputs xStatus vid res wid s Video Input Source 1 Resolution Width 1920 s Video Input Source 2 Resolution Width 0 s Video Input Source 3 Resolution Width 0 s Video Input Source 4 Resolution Width 0 s Video Output Connector 1 Resolution Width 1920 s Video Output Connector 2 Resolution Width 1280 s Video Output Connector 3 Resolution Width 1280 end Value ty...

Page 27: ... Configurations are system settings that are persistent across boots Like commands also configurations are structured in a hierarchy Writing xConfiguration on the command line lists all the top level configurations Writing xConfiguration lists all configurations and their value spaces Writing xConfiguration lists all configurations and their current values To list out only some of the configuratio...

Page 28: ...ter this is treated as input to that command including line breaks You now enter the payload for this command in accordance to the input format expected by this command When done finish with a line break n and a separate line containing just a period ending with a line break n The command will now be executed and you will get a command result with an OK or ERROR depending on the command being exec...

Page 29: ...ypes xcommand xconfiguration and xstatus A typical use of this would be to create a command queue in your application and assign unique IDs to every command sent to the codec A listener then listens to all feedback from the codec and matches the ID on the response with the corresponding ID in the command queue This enables matching the original request with the specific response Example xcommand V...

Page 30: ...68 RemoteURI h223 integratorHQ company com EncryptionIn Off EncryptionOut Off end Example 4 FECC Action request FECC Action request is an event reported when far end is sending FECC commands e FeccActionInd Id 132 Req 1 Pan 1 PanRight 1 Tilt 0 TiltUp 0 Zoom 0 ZoomIn 0 Focus 0 FocusIn 0 Timeout 300 VideoSrc 0 m 0 end Example 5 TString message received TString message received is an event reported w...

Page 31: ...scribe to the feedback by registering feedback expressions How you register feedback expressions varies according to the connection method used When using HTTP the method of handling feedback differs slightly from what is presented in this section See the Feedback from codec over HTTP on page 35 for more information Feedback expressions The expression used when registering for feedback is a varian...

Page 32: ...Standby Active on the command line the result is s Standby Active On end If you have registered for feedback on status changes the feedback you get when the system goes to standby mode will be exactly the same s Standby Active On end This means that when you are programming against the device you only need to handle one format Example Managing feedback subscriptions A Register feedback expressions...

Page 33: ...s available and they do not time out automatically Example Starting a HTTP XMLAPI session Request POST xmlapi session begin HTTP 1 1 Authorization Basic Base64 encoded authentication string Response HTTP 1 1 204 No Content Server nginx 1 8 0 Connection keep alive Set Cookie SessionId f08102c8ce5aaf8fba23a7238 cc2ef464b990e18bfbb7fb048820c0e28955c54 Path HttpOnly This session counts toward the syst...

Page 34: ...mands and configurations Using HTTP POST When sending configurations and commands to the codec it is important that the HTTP header Content Type is set to text xml i e Content Type text xml The body of the POST should contain the XML content Example 1 Changing the system name Request POST putxml HTTP 1 1 Content Type text xml Configuration SystemUnit Name newName Name SystemUnit Configuration Exam...

Page 35: ...post the HTTP feedback messages to Format Set the format for the feedback from the HTTP server to XML or JSON Expression 1 15 The XPath expression specifies which parts of the Status Configuration or Event documents are monitored You can have from 1 to 15 XPath expressions Register the expressions you want to receive feedback on See the Feedback mechanism on page 31 section for more information ab...

Page 36: ... True Number 12345 Number Protocol H323 Protocol Dial Command Example 2 Assigning volume level Terminal xCommand Audio Volume Set Level 50 XML Command Audio Volume Set command True Level 50 Level Set Volume Audio Command Translating configurations Translating from xConfiguration to XML is similar to commands but with the addition of a special attribute item NN for specifying the index in arrays Ex...

Page 37: ...lways use xConfiguration Video instead of xconf vid The shortcuts can be used for searches in the API on the command line but not for programming The reason for this is that you might end up with ambiguous code when additional commands are added to the API DO NOT subscribe to unnecessary feedback Subscribing to too much feedback may congest the control application Although the amount of feedback m...

Page 38: ...ce Guide CE9 2 NOVEMBER 2017 Copyright 2017 Cisco Systems Inc All rights reserved 38 Cisco TelePresence MX700 and MX800 API Reference Guide Chapter 3 xConfiguration commands Introduction About the API xConfiguration Appendices xCommand xStatus xConfiguration ...

Page 39: ...48 xConfiguration Audio Input Microphone 1 8 VideoAssociation VideoInputSource 49 xConfiguration Audio Input Microphone 1 8 Level 49 xConfiguration Audio Input Microphone 1 8 Mode 49 xConfiguration Audio Input Microphone 1 8 Type 49 xConfiguration Audio Output Line 1 6 Channel 50 xConfiguration Audio Output Line 1 6 Delay DelayMs 50 xConfiguration Audio Output Line 1 6 Delay Mode 50 xConfiguration...

Page 40: ... 62 xConfiguration H323 H323Alias E164 62 xConfiguration H323 H323Alias ID 62 xConfiguration H323 NAT Mode 63 xConfiguration H323 NAT Address 63 Macros configuration 64 xConfiguration Macros Mode 64 xConfiguration Macros AutoStart 64 Network configuration 64 xConfiguration Network 1 DNS Domain Name 64 xConfiguration Network 1 DNS Server 1 3 Address 64 xConfiguration Network 1 IEEE8021X Mode 65 xCo...

Page 41: ...on NetworkServices Telnet Mode 79 xConfiguration NetworkServices UPnP Mode 79 xConfiguration NetworkServices WelcomeText 80 Peripherals configuration 80 xConfiguration Peripherals Profile Cameras 80 xConfiguration Peripherals Profile ControlSystems 81 xConfiguration Peripherals Profile TouchPanels 81 Phonebook configuration 81 xConfiguration Phonebook Server 1 ID 81 xConfiguration Phonebook Server...

Page 42: ...gsMenu Mode 98 UserManagement configuration 98 xConfiguration UserManagement LDAP Mode 98 xConfiguration UserManagement LDAP Server Address 98 xConfiguration UserManagement LDAP Server Port 99 xConfiguration UserManagement LDAP Encryption 99 xConfiguration UserManagement LDAP MinimumTLSVersion 99 xConfiguration UserManagement LDAP VerifyServerCertificate 99 xConfiguration UserManagement LDAP Admin...

Page 43: ...odec and is to be available when the codec is not in a call When set to InCallOnly this will prevent the audio system from being muted by mistake xConfiguration Audio MicrophoneReinforcement Input Microphone 1 8 Mode Set the microphone reinforcement mode individually on each microphone The signals from all microphones with Mode On will be mixed and fed to the selected MicrophoneReinforcement outpu...

Page 44: ...oundsAndAlerts RingTone RingTone where RingTone Sunrise Mischief Ripples Reflections Vibes Delight Evolve Playful Ascent Calculation Mellow Ringer Select a ringtone from the list xConfiguration Audio SoundsAndAlerts RingVolume Define the ring volume for incoming calls Requires user role ADMIN INTEGRATOR USER Default value 30 USAGE xConfiguration Audio SoundsAndAlerts RingVolume RingVolume where Ri...

Page 45: ... 3 for dual camera systems Determine whether to play audio only when you present the HDMI input source or to always play audio when an audio source is connected to the HDMI input Requires user role ADMIN INTEGRATOR Default value On USAGE xConfiguration Audio Input HDMI n VideoAssociation MuteOnInactiveVideo MuteOnInactiveVideo where n Unique ID that identifies the HDMI input Range 2 3 for single c...

Page 46: ...he audio will be played locally and to far end regardless of whether the video source is presented On The audio source is associated with a video source The audio will be played locally and to far end when the associated video source is presented The audio will be muted when the video source is not presented xConfiguration Audio Input Line 1 4 VideoAssociation VideoInputSource The audio source can...

Page 47: ...ts in the audio environment If the changes in the audio conditions are significant the echo canceller may take a second or two to re adjust Requires user role ADMIN INTEGRATOR Default value On USAGE xConfiguration Audio Input Microphone n EchoControl Mode Mode where n Unique ID that identifies the microphone input Range 1 8 Mode Off On Off Turn off the echo control Recommended if external echo can...

Page 48: ...ID Integer 1 8 Set the equalizer ID xConfiguration Audio Input Microphone 1 8 Equalizer Mode Define the equalizer mode for the source that is connected to the microphone input Requires user role ADMIN INTEGRATOR Default value Off USAGE xConfiguration Audio Input Microphone n Equalizer Mode Mode where n Unique ID that identifies the microphone input Range 1 8 Mode Off On Off No equalizer On Enable ...

Page 49: ...l Level where n Unique ID that identifies the microphone input Range 1 8 Level Integer 0 70 Select a value between 0 and 70 in steps of 1 dB xConfiguration Audio Input Microphone 1 8 Mode Disable or enable audio on the microphone connector Requires user role ADMIN INTEGRATOR Default value On USAGE xConfiguration Audio Input Microphone n Mode Mode where n Unique ID that identifies the microphone in...

Page 50: ... DelayMs DelayMs where n Unique ID that identifies the audio line output Range 1 6 DelayMs Integer 0 290 The delay in milliseconds xConfiguration Audio Output Line 1 6 Delay Mode You may add extra delay to an audio line output with the Audio Output Line n Delay DelayMs setting The extra delay added is either a fixed number of milliseconds or a number of millisec onds relative to the detected delay...

Page 51: ...quires user role ADMIN INTEGRATOR Default value 10 USAGE xConfiguration Audio Output Line n Level Level where n Unique ID that identifies the audio line output Range 1 6 Level Integer 24 0 Select a value between 24 and 0 in steps of 1 dB xConfiguration Audio Output Line 1 6 Mode Define the mode for the audio line output Requires user role ADMIN INTEGRATOR Default value On USAGE xConfiguration Audi...

Page 52: ...EDID information The default value is an empty string Requires user role ADMIN INTEGRATOR Default value USAGE xConfiguration Cameras Camera n AssignedSerialNumber AssignedSerialNumber where n Unique ID that identifies the camera Range 1 7 AssignedSerialNumber String 0 20 The camera s serial number xConfiguration Cameras Camera 1 7 Backlight DefaultMode This configuration turns backlight compensati...

Page 53: ...tomatically flipped If the camera cannot auto detect whether it is mounted upside down or not the image is not changed Off Display the image on screen the normal way On Display the image flipped upside down This setting is used when a camera is mounted upside down but cannot automatically detect which way it is mounted xConfiguration Cameras Camera n 7 Focus Mode Define the camera focus mode Requi...

Page 54: ...el Integer 0 7 Define the gamma level xConfiguration Cameras Camera n 7 Mirror This setting applies to Camera 2 7 for single camera systems and to HDMI 3 7 for dual camera systems With Mirror mode horizontal flip you can mirror the image on screen Mirroring applies both to the self view and the video that is transmitted to the far end Requires user role ADMIN INTEGRATOR Default value Auto USAGE xC...

Page 55: ... camera assembly consists of two cameras and uses an audio tracking technique that finds and captures a close up of the active speaker When a change of speaker is detected the system can switch automatically between the two cameras to always show the best camera view Refer to the Cameras SpeakerTrack TrackingMode setting for different switching modes Requires user role ADMIN INTEGRATOR Default val...

Page 56: ...ack ConnectorDetection CameraLeft Not applicable in this version USAGE xConfiguration Cameras SpeakerTrack ConnectorDetection CameraLeft CameraLeft where xConfiguration Cameras SpeakerTrack ConnectorDetection CameraRight Not applicable in this version USAGE xConfiguration Cameras SpeakerTrack ConnectorDetection CameraRight CameraRight where xConfiguration Cameras SpeakerTrack Whiteboard Mode This ...

Page 57: ...xConfiguration Conference AutoAnswer Mute Mute where Mute Off On Off The incoming call will not be muted On The incoming call will be muted when automatically answered xConfiguration Conference AutoAnswer Delay Define how long in seconds an incoming call has to wait before it is answered automatically by the system Requires that AutoAnswer Mode is switched on Requires user role ADMIN Default value...

Page 58: ...en for a few seconds when the conference starts NOTE If the Encryption Option Key is not installed on the video system the encryption mode is always Off Requires user role ADMIN Default value BestEffort USAGE xConfiguration Conference Encryption Mode Mode where Mode Off On BestEffort Off The system will not use encryption On The system will only allow calls that are encrypted BestEffort The system...

Page 59: ...nt video conference Define the maximum overall receive bit rate allowed The bit rate will be divided fairly among all active calls at any time This means that the individual calls will be up speeded or down speeded as appropriate when someone leaves or enters a multipoint conference or when a call is put on hold suspended or resumed The maximum receive bit rate for each individual call is defined ...

Page 60: ...alls InputMuteMicrophones InputNoAction OutputAllCallsEncrypted OutputInCall OutputManualState OutputMicrophonesMuted OutputPresentationOn OutputStandbyActive InputAcceptAllCalls When the pin is activated the xCommand Call Accept command which accepts all incoming calls will be issued InputDisconnectAllCalls When the pin is activated the xCommand Call Disconnect command which disconnects all calls...

Page 61: ...uthentication Mode to be enabled Requires user role ADMIN Default value USAGE xConfiguration H323 Authentication LoginName LoginName where LoginName String 0 50 The authentication login name xConfiguration H323 Authentication Password The system sends the H323 Authentication Login Name and the H323 Authentication Password to an H 323 Gatekeeper for authentication The authentication is a one way au...

Page 62: ...er Requires user role ADMIN Default value USAGE xConfiguration H323 Gatekeeper Address Address where Address String 0 255 A valid IPv4 address IPv6 address or DNS name xConfiguration H323 H323Alias E164 The H 323 Alias E 164 defines the address of the system according to the numbering plan implemented in the H 323 Gatekeeper The E 164 alias is equivalent to a telephone number sometimes combined wi...

Page 63: ...as well as endpoints on the WAN If the H323 NAT Address is wrong or not set the real IP address will be used Off The system will signal the real IP address On The system will signal the configured H323 NAT Address instead of its real IP address in Q 931 and H 245 The NAT server address will be shown in the startup menu as My IP Address 10 0 2 1 If the H323 NAT Address is wrong or not set H 323 cal...

Page 64: ...ideo system the runtime will automatically start again if auto start is enabled Requires user role ADMIN Default value Off USAGE xConfiguration Macros AutoStart AutoStart where AutoStart Off On Off The macro runtime will not start automatically after a restart of the video system On The macro runtime will start automatically after a restart of the video system Network configuration xConfiguration ...

Page 65: ...Off TLS connections are allowed without verifying the server side X 509 certificate against the local CA list This should typically be selected if no CA list has been uploaded to the codec 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 xConfiguration Network 1 IEEE8021X Us...

Page 66: ...ty where n Index that identifies the network Range 1 1 AnonymousIdentity String 0 64 The 802 1X Anonymous ID string xConfiguration Network 1 IEEE8021X Eap Md5 Define the Md5 Message Digest Algorithm 5 mode This is a Challenge Handshake Authentication Protocol that relies on a shared secret Md5 is a Weak security Requires user role ADMIN USER Default value On USAGE xConfiguration Network n IEEE8021...

Page 67: ... is enabled default xConfiguration Network 1 IPStack Select if the system should use IPv4 IPv6 or dual IP stack on the network interface NOTE After changing this setting you may have to wait up to 30 seconds before it takes effect Requires user role ADMIN USER Default value Dual USAGE xConfiguration Network n IPStack IPStack where n Index that identifies the network Range 1 1 IPStack Dual IPv4 IPv...

Page 68: ...hat identifies the network Range 1 1 SubnetMask String 0 64 A valid IPv4 address xConfiguration Network 1 IPv6 Assignment Define how the system will obtain its IPv6 address and the default gateway address This setting applies only to systems on IPv6 networks Requires user role ADMIN USER Default value Autoconf USAGE xConfiguration Network n IPv6 Assignment Assignment where n Index that identifies ...

Page 69: ...eway Gateway where n Index that identifies the network Range 1 1 Gateway String 0 64 A valid IPv6 address xConfiguration Network 1 IPv6 DHCPOptions Retrieve a set of DHCP options for example NTP and DNS server addresses from a DHCPv6 server Requires user role ADMIN USER Default value On USAGE xConfiguration Network n IPv6 DHCPOptions DHCPOptions where n Index that identifies the network Range 1 1 ...

Page 70: ...rk QoS Diffserv Video Network QoS Diffserv Data Network QoS Diffserv Signalling Network QoS Diffserv ICMPv6 and Network QoS Diffserv NTP settings are used to prioritize packets xConfiguration Network 1 QoS Diffserv Audio This setting will only take effect if Network QoS Mode is set to Diffserv Define which priority Audio packets should have in the IP network The priority for the packets ranges fro...

Page 71: ...ideo where n Index that identifies the network Range 1 1 Video Integer 0 63 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 xConfiguration Network 1 QoS Diffserv Data This setting will only take effect if Network QoS Mode is set to Diffserv Define which priority Data packets should have in the IP network The p...

Page 72: ... Index that identifies the network Range 1 1 Signalling Integer 0 63 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 xConfiguration Network 1 QoS Diffserv ICMPv6 This setting will only take effect if Network QoS Mode is set to Diffserv Define which priority ICMPv6 packets should have in the IP network The...

Page 73: ...sses are separated by a white space A network mask IP range is specified by ip address N where N is 1 32 for IPv4 and N is 1 128 for IPv6 The N is a common indication of a network mask where the first N bits are set Thus 192 168 0 0 24 would match any address starting with 192 168 0 since these are the first 24 bits in the address Requires user role ADMIN USER Default value USAGE xConfiguration Ne...

Page 74: ...fine the VLAN voice ID This setting will only take effect if Network VLAN Voice Mode is set to Manual Requires user role ADMIN USER Default value 1 USAGE xConfiguration Network n VLAN Voice VlanId VlanId where n Index that identifies the network Range 1 1 VlanId Integer 1 4094 Set the VLAN voice ID NetworkServices configuration xConfiguration NetworkServices CDP Mode Enable or disable the CDP Cisc...

Page 75: ... is provisioned to Cisco Spark The HTTP proxy settings makes it possible to onboard a video system behind a HTTP proxy to Spark Requires user role ADMIN USER Default value True USAGE xConfiguration NetworkServices HTTP Proxy Allowed Allowed where Allowed False True False The HTTP proxy settings are not available from the Cisco Spark setup wizard True The HTTP proxy settings are available from the ...

Page 76: ... Proxy Url Url where Url String 0 255 The URL for the HTTP proxy server xConfiguration NetworkServices HTTPS Server MinimumTLSVersion Set the lowest version of the TLS Transport Layer Security protocol that is allowed Requires user role ADMIN Default value TLSv1 1 USAGE xConfiguration NetworkServices HTTPS Server MinimumTLSVersion MinimumTLSVersion where MinimumTLSVersion TLSv1 1 TLSv1 2 TLSv1 1 S...

Page 77: ... CA This requires that a list of trusted CAs are uploaded to the system in advance xConfiguration NetworkServices NTP Mode The Network Time Protocol NTP is used to synchronize the system s time and date to a refer ence time server The time server will be queried regularly for time updates Requires user role ADMIN Default value Auto USAGE xConfiguration NetworkServices NTP Mode Mode where Mode Auto...

Page 78: ...ice ReadOnly Enable the SNMP network service for queries only ReadWrite Enable the SNMP network service for both queries and commands xConfiguration NetworkServices SNMP Host 1 3 Address Define the address of up to three SNMP Managers The system s SNMP Agent in the codec responds to requests from SNMP Managers a PC program etc for example about system location and system contact SNMP traps are not...

Page 79: ...AN connections Requires user role ADMIN Default value Off USAGE xConfiguration NetworkServices Telnet Mode Mode where Mode Off On Off The Telnet protocol is disabled This is the factory setting On The Telnet protocol is enabled xConfiguration NetworkServices UPnP Mode Fully disable UPnP Universal Plug and Play or enable UPnP for a short time period after the video system has been switched on or re...

Page 80: ...n successful Peripherals configuration xConfiguration Peripherals Profile Cameras Define the number of cameras 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 cameras does not match this setting the diagnostics service will report it as an inconsistency Requires user role ADMIN INTEGRATOR Default va...

Page 81: ...ystem s diagnostics service If the number of connected Touch controllers does not match this setting the diagnostics service will report it as an inconsistency Requires user role ADMIN INTEGRATOR Default value Minimum1 USAGE xConfiguration Peripherals Profile TouchPanels TouchPanels where TouchPanels NotSet Minimum1 0 1 2 3 4 5 NotSet No touch panel check is performed Minimum1 At least one Cisco T...

Page 82: ...figuration Provisioning Connectivity This setting controls how the device discovers whether it should request an internal or external configuration from the provisioning server Requires user role ADMIN USER Default value Auto USAGE xConfiguration Provisioning Connectivity Connectivity where Connectivity Internal External Auto Internal Request internal configuration External Request external config...

Page 83: ...Unified Communications Manager The system connects to CUCM via the Collaboration Edge infrastructure In order to register over Edge the encryption option key must be installed on the video system 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 Cisc...

Page 84: ...y DHCP Requires user role ADMIN USER Default value USAGE xConfiguration Provisioning ExternalManager Address Address where Address String 0 64 A valid IPv4 address IPv6 address or DNS name xConfiguration Provisioning ExternalManager AlternateAddress Only applicable when the endpoint is provisioned by Cisco Unified Communication Manager CUCM and an alternate CUCM is available for redundancy Define ...

Page 85: ...that they are close to the video system In order to use a client at least one of the Proximity services must be enabled refer to the Proximity Services settings In general Cisco recommends enabling all the Proximity services Requires user role ADMIN USER Default value On USAGE xConfiguration Proximity Mode Mode where Mode Off On Off The video system does not emit ultrasound and Proximity services ...

Page 86: ...e snapshots This service is supported by mobile devices iOS and Android Proximity Mode must be On for this setting to take any effect Requires user role ADMIN USER Default value Disabled USAGE xConfiguration Proximity Services ContentShare ToClients ToClients where ToClients Enabled Disabled Enabled Content sharing to a Proximity client is enabled Disabled Content sharing to a Proximity client is ...

Page 87: ...rt Other connection parameters for the serial port are Data bits 8 Parity None Stop bits 1 Flow control None Requires user role ADMIN INTEGRATOR Default value 115200 USAGE xConfiguration SerialPort BaudRate BaudRate where BaudRate 9600 19200 38400 57600 115200 Set a baud rate from the baud rates listed bps xConfiguration SerialPort LoginRequired Define if login shall be required when connecting to...

Page 88: ...ransport protocol to be used over the LAN Requires user role ADMIN Default value Auto USAGE xConfiguration SIP DefaultTransport DefaultTransport where DefaultTransport TCP UDP Tls Auto TCP The system will always use TCP as the default transport method UDP The system will always use UDP as the default transport method Tls The system will always use TLS as the default transport method For TLS connec...

Page 89: ...didate Host Rflx Relay Host Send media to the video system s private IP address 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 xConfiguration SIP ListenPort Turn on or off the listening for incoming connections on the SIP TCP UDP ports If turned off the endpoint will only be reachable throu...

Page 90: ...for accessing the TURN server Requires user role ADMIN Default value USAGE xConfiguration SIP Turn UserName UserName where UserName String 0 128 A valid user name xConfiguration SIP Turn Password Define the password needed for accessing the TURN server Requires user role ADMIN Default value USAGE xConfiguration SIP Turn Password Password where Password String 0 128 A valid password xConfiguration ...

Page 91: ...dby Delay Delay where Delay Integer 1 480 Set the standby delay minutes xConfiguration Standby BootAction Define the camera position after a restart of the codec Requires user role ADMIN INTEGRATOR USER Default value DefaultCameraPosition USAGE xConfiguration Standby BootAction BootAction where BootAction None DefaultCameraPosition RestoreCameraPosition None No action RestoreCameraPosition When th...

Page 92: ...up on motion detection is disabled On When people walk into the room the system will automatically wake up from standby xConfiguration Standby PowerSave You can reduce the video system s power consumption during out of office hours with this setting The Power Save mode is an extension to the regular standby mode When the video system enters power save mode power is cut to some of the video system ...

Page 93: ...on xConfiguration Time TimeFormat Define the time format Requires user role ADMIN USER Default value 24H USAGE xConfiguration Time TimeFormat TimeFormat where TimeFormat 24H 12H 24H Set the time format to 24 hours 12H Set the time format to 12 hours AM PM xConfiguration Time DateFormat Define the date format Requires user role ADMIN USER Default value DD_MM_YY USAGE xConfiguration Time DateFormat ...

Page 94: ...oros America Mazatlan America Mendoza America Menominee America Merida America Metlakatla America Mexico_City America Miquelon America Moncton America Monterrey America Montevideo America Montreal America Montserrat America Nassau America New_York America Nipigon America Nome America Noronha America North_ Dakota Beulah America North_Dakota Center America North_Dakota New_Salem America Ojinaga Ame...

Page 95: ...jaSur Mexico General NZ NZ CHAT Navajo PRC PST8PDT Pacific Apia Pacific Auckland Pacific Bougainville Pacific Chatham Pacific Chuuk Pacific Easter Pacific Efate Pacific Enderbury Pacific Fakaofo Pacific Fiji Pacific Funafuti Pacific Galapagos Pacific Gambier Pacific Guadalcanal Pacific Guam Pacific Honolulu Pacific Johnston Pacific Kiritimati Pacific Kosrae Pacific Kwajalein Pacific Majuro Pacific...

Page 96: ...USER Default value Friday USAGE xConfiguration Time WorkWeek LastDayOfWeek LastDayOfWeek where LastDayOfWeek Monday Tuesday Wednesday Thursday Friday Saturday Sunday The last day of the working week Example Friday UserInterface configuration xConfiguration UserInterface ContactInfo Type Choose which type of contact information to show in the status field in the upper left corner of the display and...

Page 97: ...be used in menus and messages on the screen and Touch controller Requires user role ADMIN USER Default value English USAGE xConfiguration UserInterface Language Language where Language Arabic Catalan ChineseSimplified ChineseTraditional Czech Danish Dutch English EnglishUK Finnish French FrenchCanadian German Hebrew Hungarian Italian Japanese Korean Norwegian Polish Portuguese PortugueseBrazilian ...

Page 98: ...tting Some settings do not require authentication they do not have a padlock icon Requires user role ADMIN Default value Unlocked USAGE xConfiguration UserInterface OSD SettingsMenu Mode Mode where Mode Locked Unlocked Locked Authentication with administrator s username and passphrase is required Unlocked No authentication is required UserManagement configuration xConfiguration UserManagement LDAP...

Page 99: ...on UserManagement LDAP MinimumTLSVersion Set the lowest version of the TLS Transport Layer Security protocol that is allowed Requires user role ADMIN Default value TLSv1 2 USAGE xConfiguration UserManagement LDAP MinimumTLSVersion MinimumTLSVersion where MinimumTLSVersion TLSv1 0 TLSv1 1 TLSv1 2 TLSv1 0 Support TLS version 1 0 or higher TLSv1 1 Support TLS version 1 1 or higher TLSv1 2 Support TLS...

Page 100: ...on UserManagement LDAP Admin Group Members of this AD Active Directory group will be given administrator access This setting is a shorthand for saying memberOf 1 2 840 113556 1 4 1941 group name If UserManagement LDAP Admin Filter is set this setting is ignored Requires user role ADMIN Default value USAGE xConfiguration UserManagement LDAP Admin Group Group where Group String 0 255 The distinguish...

Page 101: ...rent cameras Requires user role ADMIN INTEGRATOR Default value Connector n n Connector 5 1 USAGE xConfiguration Video Input Connector n CameraControl CameraId CameraId where n Unique ID that identifies the video input connector Range 1 5 CameraId Connector 1 2 3 4 1 2 3 4 5 6 7 Connector 5 1 Select the ID of the camera xConfiguration Video Input Connector 4 DviType The official DVI standard suppor...

Page 102: ... a presentation source normally the main camera will not be used as a presentation source If the video system is in standby mode it will wake up when you connect a presentation source Sharing the presentation with the far end requires additional action select Share on the user interface except when this setting is set to AutoShare Requires user role ADMIN INTEGRATOR Default value Connector 1 2 Man...

Page 103: ...e is assigned to each monitor using the Video Output Connector n MonitorRole setting The monitor role decides which layout call participants and presentation will appear on the monitor that is connected to this output Monitors with the same monitor role will get the same layout monitors with different monitor roles will have different layouts The monitor layout mode that is set in the Video Monito...

Page 104: ... 2 Mode Off On Off CEC is disabled On CEC is enabled xConfiguration Video Output Connector 1 3 MonitorRole The monitor role describes which video streams will be shown on the monitor connected to this video output connector Together the Video Monitors setting and the MonitorRole settings for all outputs define which layout video streams will be shown on each monitor Requires user role ADMIN INTEGR...

Page 105: ... user role ADMIN USER Default value 3 USAGE xConfiguration Video Presentation DefaultSource DefaultSource where DefaultSource 1 2 3 4 The video input source to use as default presentation source xConfiguration Video Selfview Default Mode Define if the main video source self view shall be displayed on screen after a call The position and size of the self view window is determined by the Video Selfv...

Page 106: ...lf view picture will be shown on outputs with the Video Output Connector n MonitorRole set to Third xConfiguration Video Selfview Default PIPPosition Define the position on screen of the small self view picture in picture PiP after a call The setting only takes effect when self view is switched on see the Video Selfview Default Mode setting and fullscreen view is switched off see the Video Selfvie...

Page 107: ...o Selfview OnCall Mode Mode where Mode Off On Off Self view is not shown automatically during call setup On Self view is shown automatically during call setup xConfiguration Video Selfview OnCall Duration This setting only has an effect when the Video Selfview OnCall Mode setting is switched On In this case the number of seconds set here determines for how long self view is shown before it is auto...

Page 108: ...ference Guide CE9 2 NOVEMBER 2017 Copyright 2017 Cisco Systems Inc All rights reserved 108 Cisco TelePresence MX700 and MX800 API Reference Guide Chapter 4 xCommand commands Introduction About the API xConfiguration Appendices xCommand xStatus xCommand ...

Page 109: ...mand Call Accept 118 xCommand Call Disconnect 118 xCommand Call DTMFSend 118 xCommand Call FarEndControl Camera Move 118 xCommand Call FarEndControl Camera Stop 119 xCommand Call FarEndControl RoomPreset Activate 119 xCommand Call FarEndControl Source Select 119 xCommand Call Forward 119 xCommand Call Hold 120 xCommand Call Ignore 120 xCommand Call Join 120 xCommand Call Reject 120 xCommand Call R...

Page 110: ...mands 131 xCommand Conference DoNotDisturb Activate 131 xCommand Conference DoNotDisturb Deactivate 131 xCommand Conference SpeakerLock Release 131 xCommand Conference SpeakerLock Set 132 Diagnostics commands 132 xCommand Diagnostics Run 132 Dial commands 133 xCommand Dial 133 GPIO commands 133 xCommand GPIO ManualState Set 133 HttpFeedback commands 134 xCommand HttpFeedback Deregister 134 xComman...

Page 111: ...ecurity commands 148 xCommand Security Certificates CA Add 148 xCommand Security Certificates CA Delete 148 xCommand Security Certificates CA Show 148 xCommand Security Certificates Services Activate 148 xCommand Security Certificates Services Add 148 xCommand Security Certificates Services Deactivate 149 xCommand Security Certificates Services Delete 149 xCommand Security Certificates Services Sh...

Page 112: ...1 xCommand UserInterface Presentation ExternalSource State Set 161 UserManagement commands 162 xCommand UserManagement RemoteSupportUser Create 162 xCommand UserManagement RemoteSupportUser Delete 162 xCommand UserManagement RemoteSupportUser DisablePermanently 162 xCommand UserManagement RemoteSupportUser GetState 162 xCommand UserManagement User Add 163 xCommand UserManagement User Delete 163 xC...

Page 113: ...easurementLength Integer 1 100 The length of the measurement in number of seconds In a noisy environment a longer measurement time will give a more reliable and robust result The default is set to 6 Output HDMI Line Internal All HDMI Measure the delay of the device connected to the HDMI output Line Measure the delay of the device connected to the Line output only available on video systems that ha...

Page 114: ...nd Audio Sound Stop xCommand Audio SpeakerCheck Runs a test that you can use to check that all the internal speakers are connected correctly A test tone will be emitted from each speaker in sequence from left to right If the speakers don t play in correct order reconnect the loudspeaker cables to obtain the correct sequence All speakers are part of the test sequence and you must be in the same roo...

Page 115: ... Increase the volume on the endpoint By default the volume is increased by 5 steps each step is 0 5 dB Use the Steps parameter if you want to override the default behavior Requires user role ADMIN USER USAGE xCommand Audio Volume Increase Steps Steps where Steps Integer 1 10 Choose the number of steps to increase the volume with One step is 0 5 dB The default is set to 5 xCommand Audio Volume Mute...

Page 116: ...8 for Microphone Integer 1 4 for Line Integer 1 3 for HDMI Select a connector number Together with the ConnectorType it uniquely identifies the connector ConnectorType HDMI Line Microphone Select the connector type IncludePairingQuality Literal Off On The default is set to Off xCommand Audio VuMeter Stop Stop the VU meter on the specified connector You have to specify both the connector s type and...

Page 117: ... system The list of booking details is received from the management system All parameters are optional and can be used to limit the search result If no parameters are set past present and future bookings are all listed To avoid listing bookings from yesterday and before use DayOffset 0 Requires user role ADMIN USER USAGE xCommand Bookings List Days Days DayOffset DayOffset Limit Limit Offset Offse...

Page 118: ...he default is set to 0 xCommand Call DTMFSend Send DTMF tones to the far end Requires user role ADMIN USER USAGE xCommand Call DTMFSend CallId CallId DTMFString DTMFString where CallId Integer 0 65534 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 The default is set to 1 DTMFString String 0 32 Enter the DTMF strin...

Page 119: ...d PresetId where CallId Integer 0 65534 The CallId is required to identify the far end codec only when in a Multipoint call The CallId is returned when issuing the xCommand Dial command During a call you can run the xStatus Call command to see the CallId The default is set to 1 PresetId Integer 1 15 The ID of the preset that is stored on the far end codec xCommand Call FarEndControl Source Select ...

Page 120: ...and is run During a call you can run the xStatus Call command to see the CallId xCommand Call Join Internal usage only Requires user role ADMIN USER USAGE xCommand Call Join CallId CallId where CallId Integer 0 65534 You can have from 1 to 10 CallId parameters in the same command xCommand Call Reject Reject incoming call If no call id is specified all incoming calls are rejected Requires user role...

Page 121: ...user role ADMIN USER USAGE xCommand CallHistory AcknowledgeAllMissedCalls xCommand CallHistory AcknowledgeMissedCall Turns off the missed calls indicator on the touch controller for the specified call Requires user role ADMIN USER USAGE xCommand CallHistory AcknowledgeMissedCall CallHistoryId CallHistoryId AcknowledgeConsecutiveDuplicates AcknowledgeConsecutiveDuplicates where CallHistoryId Intege...

Page 122: ... information or not The default is set to False xCommand CallHistory Get Retrieve all information on previous calls made on the video system Requires user role ADMIN USER USAGE xCommand CallHistory Get Filter Filter Offset Offset Limit Limit DetailLevel DetailLevel SearchString SearchString CallHistoryId CallHistoryId where Filter All Missed AnsweredElsewhere Forwarded Placed NoAnswer Received Rej...

Page 123: ...5534 Defines the amount of calls in the output The default is set to 65534 DetailLevel Basic Full Sets the level of detail for the information on these calls The default is set to Basic SearchString String 0 255 Allows you to set the command to apply to a specified display name or call back number CallHistoryId Integer 0 65534 CallHistoryId for the call in question Order OccurrenceTime OccurrenceF...

Page 124: ...that the xCommand Camera Preset commands applies to an individual camera This is in contrast to the xCommand Preset commands where a single preset covers ALL connected cameras plus the Video Input switcher settings Requires user role ADMIN USER USAGE xCommand Camera Preset Activate PresetId PresetId where PresetId Integer 1 35 The ID of the camera preset you want to activate xCommand Camera Preset...

Page 125: ...ist command DefaultProsition False True Defines whether or not this preset is the default position for the associated camera Note that each camera can only have one default position so if set the old default preset will automatically be marked as not default xCommand Camera Preset List List information about available camera presets Note that the xCommand Camera Preset commands applies to an indiv...

Page 126: ...complete sets of camera positions The individual camera presets are not available for far end control Requires user role ADMIN USER USAGE xCommand Camera Preset Store PresetId PresetId CameraId CameraId ListPosition ListPosition Name Name TakeSnapshot TakeSnapshot DefaultProsition DefaultProsition where PresetId Integer 1 35 The ID of this camera preset If not set explicitly the codec will assign ...

Page 127: ...mera Ramp CameraId CameraId Pan Pan PanSpeed PanSpeed Tilt Tilt TiltSpeed TiltSpeed Zoom Zoom ZoomSpeed ZoomSpeed Focus Focus where CameraId Integer 1 7 Select the camera Pan Left Right Stop Move the camera to the Left or Right followed by Stop PanSpeed Integer 1 15 Set the pan speed Tilt Down Up Stop Move the camera Up or Down followed by Stop TiltSpeed Integer 1 15 Set the tilt speed Zoom In Out...

Page 128: ...here CameraId 1 7 Select which camera to diagnose xCommand Cameras PresenterTrack ClearPosition Clear the stored presenter tracking camera position for the overview image of the stage The PresenterTrack feature will still work after the camera position has been cleared but the camera will not view a predefined position upon activation Requires user role ADMIN INTEGRATOR USER USAGE xCommand Cameras...

Page 129: ...se face detection After some seconds the tracking stops BLUE A face is detected but the face is not tracked Background This setting is used by the codec s internal scripts Turns on presenter tracking with no cropping of the image Setup This setting is used by the codec s web interface to show the trigger zone on the video system screen when setting up the PresenterTrack feature Persistent This set...

Page 130: ...erTrack cameras Requires user role ADMIN INTEGRATOR USER USAGE xCommand Cameras SpeakerTrack Diagnostics Stop xCommand Cameras SpeakerTrack Whiteboard ActivatePosition Moves the specified camera to the position stored with xCommand Cameras SpeakerTrack Whiteboard StorePosition Requires user role ADMIN USER USAGE xCommand Cameras SpeakerTrack Whiteboard ActivatePosition CameraId CameraId Whiteboard...

Page 131: ...ras Requires user role ADMIN USER USAGE xCommand Cameras SpeakerTrack Whiteboard StorePosition CameraId CameraId WhiteboardId WhiteboardId where CameraId Integer 1 7 The ID of the camera that is being positioned WhiteboardId Integer 1 8 You can give the position an id number Currently the only id that can be used is 1 The default is set to 1 Conference commands xCommand Conference DoNotDisturb Act...

Page 132: ...t CallId CallId where Target local remote Identifies local or remote participant CallId Integer 0 65534 Identify CallID for the remote participant Only relevant if Target is set to remote The default is set to 0 Diagnostics commands xCommand Diagnostics Run This command runs self diagnostics commands on the system Requires user role ADMIN USAGE xCommand Diagnostics Run ResultSet ResultSet where Re...

Page 133: ... Spark Select the call protocol CallRate Integer 64 6000 Set the call rate CallType Audio Video Select the call type BookingId String 0 255 Any identifier that an external booking system e g TMS CTS MAN can use for its own references to match placed calls with the booking systems internal identifier for a meeting This can be any string e g a GUID The booking Id is supplied in call logs call events...

Page 134: ...egister FeedbackSlot FeedbackSlot Format Format ServerUrl ServerUrl Expression Expression where FeedbackSlot Integer 1 4 The codec can register up to 4 slots of servers requesting HTTP feedback Set the registering to one of them Note Avoid using FeedbackSlot 3 in an environment where Cisco TelePresence Management Suite TMS is used as TMS uses this feedbackslot to register its expressions Format XM...

Page 135: ...Macro Activate Name Name where Name String 0 255 Specifies the name of the macro to activate xCommand Macros Macro Deactivate Deactivates a macro currently running on this video system Requires user role ADMIN USAGE xCommand Macros Macro Deactivate Name Name where Name String 0 255 The name of the macro to deactivate xCommand Macros Macro Get Shows the details of a macro created on this video syst...

Page 136: ...ring 0 255 The name of the macro that is set Role String 0 255 The name of the role that is set xCommand Macros Macro Save Saves the details of a macro This is a multiline command Requires user role ADMIN USAGE xCommand Macros Macro Save Name Name Overwrite Overwrite where Name String 0 255 The name of the macro that is saved Overwrite Literal False True Overwrites the existing content or not The ...

Page 137: ...Stops all of the macros set up on this device Requires user role ADMIN USAGE xCommand Macros Runtime Stop Message commands xCommand Message Send Triggers a Message Send event which sends text to any listening clients Requires user role ADMIN INTEGRATOR USAGE xCommand Message Send Text Text where Text String 0 255 The text that the message contains Introduction About the API xConfiguration Appendic...

Page 138: ...the device you are connecting to SerialNumber String 0 100 The device s serial number SoftwareInfo String 0 100 Software version the device is running Type Byod ControlSystem Other TouchPanel Define the type of device you are connecting to xCommand Peripherals HeartBeat When a peripheral is registered as a connected device you can set it to send a heartbeat to the codec to let the codec know that ...

Page 139: ...ring Pair Pair an ISDN Link to an endpoint Requires user role ADMIN USAGE xCommand Peripherals Pairing Pair MacAddress MacAddress where MacAddress String 1 1450 Enter the MAC address for the ISDN Link you wish to pair to the endpoint xCommand Peripherals Pairing Unpair Unpair endpoint from an ISDN Link when the two have contact Requires user role ADMIN USAGE xCommand Peripherals Pairing Unpair Mac...

Page 140: ...RL String 0 255 Currently not in use Title String 0 255 The title of the contact Number String 0 255 The phone number or address of the contact Protocol Auto H320 H323 SIP Spark Select the Auto Spark SIP H323 or H320 protocol CallRate Integer 0 6000 Set a call rate The default is set to 0 CallType Audio Video Select a call type audio or video Device Mobile Other Telephone Video Select the device t...

Page 141: ...avorite Tag the contact as a Favorite or untag an already tagged contact xCommand Phonebook ContactMethod Add Add contact details for an existing contact in the local phonebook The command returns the ContactMethodId which is a unique string that identifies the contact method typically the format is n You can add several contact methods to a contact Note that only the first contact method will app...

Page 142: ...tails about the contact method for an existing contact in the local phonebook Requires user role ADMIN USER USAGE xCommand Phonebook ContactMethod Modify ContactId ContactId ContactMethodId ContactMethodId Device Device Number Number Protocol Protocol CallRate CallRate CallType CallType where ContactId String 0 255 The unique identifier for the contact The identifier will be returned by an xComman...

Page 143: ...onebook Requires user role ADMIN USER USAGE xCommand Phonebook Folder Delete FolderId FolderId where FolderId String 0 255 The unique identifier for the folder The identifier will be returned by an xCommand Phonebook Search command It was also returned when the xCommand Phonebook Folder Add command was issued to make the folder xCommand Phonebook Folder Modify Modify an existing phonebook folder R...

Page 144: ...h the string If no FolderId is specified all folders phonebook directories will be searched SearchField Name Number Currently not in use Offset Integer 0 65534 Get records starting with this offset in a search The default value is 0 Offset is used together with Limit to support paging The default is set to 0 FolderId String 0 255 Search only in the specified folder The FolderId string is listed in...

Page 145: ...e ADMIN USER USAGE xCommand Presentation Stop Instance Instance PresentationSource PresentationSource where Instance 1 2 3 4 5 6 Select which local presentation you wish to stop identified by presentation instance PresentationSource Integer 1 4 Select which local presentation you wish to stop identified by source number Provisioning commands xCommand Provisioning CompleteUpgrade Starts installing ...

Page 146: ...mmand Provisioning ExtensionMobility Login UserId UserId Pin Pin Profile Profile where UserId String 1 255 A valid user name as set up in CUCM Pin String 1 255 A valid pin code for the user as set up in CUCM Profile String 1 255 A valid profile for the user as set up in CUCM This parameter applies only if the user has multiple profiles xCommand Provisioning ExtensionMobility Logout This command wi...

Page 147: ...t Clear PresetId PresetId where PresetId Integer 1 15 The ID of the preset you want to delete xCommand RoomPreset Store Store the connector selections for all video input sources and the current position pan and tilt zoom and focus values for all cameras Note that information about all video input sources and pan tilt zoom and focus values for all cameras are included in the same preset The system...

Page 148: ...ires user role ADMIN USER USAGE xCommand Security Certificates CA Show Format Format where Format Literal PEM Text Specifies the format of the results The default is set to Text xCommand Security Certificates Services Activate Activates a security certificate on this device Requires user role ADMIN USAGE xCommand Security Certificates Services Activate Fingerprint Fingerprint Purpose Purpose where...

Page 149: ...plies to this certificate xCommand Security Certificates Services Delete Deletes security certificates from this device Requires user role ADMIN USAGE xCommand Security Certificates Services Delete Fingerprint Fingerprint where Fingerprint String 0 128 The unique Identifier for the certificate that is deleted You can get the fingerprint ID by running xCommand Security Certificates Services Show xC...

Page 150: ...mode all configurations are set back to default when the system reboots CallHistory NonPersistent Persistent In non persistent mode call history is deleted when the system reboots InternalLogging NonPersistent Persistent In non persistent mode eventlog is deleted when the system reboots LocalPhonebook NonPersistent Persistent In non persistent mode local phone book is deleted when the system reboo...

Page 151: ...o Halfwake state This state informs the user from the UI to pick up a remote or to tap the touch device to get started Requires user role ADMIN INTEGRATOR USAGE xCommand Standby Halfwake xCommand Standby ResetTimer Set a temporary standby delay If the system is in standby mode when the reset timer is set the system is brought out of standby mode When left idle for the given delay the system goes i...

Page 152: ...aviour can be forced by selecting a different TrailingAction Requires user role ADMIN USER USAGE xCommand SystemUnit FactoryReset Confirm Confirm Keep Keep TrailingAction TrailingAction where Confirm Yes Include to confirm your choice Keep Certificates LocalSetup Network Provisioning SerialPort Spark Select which configurations to keep when you factory reset the system You can have up to 6 CallId ...

Page 153: ...ry default settings Requires user role ADMIN INTEGRATOR USER USAGE xCommand SystemUnit FirstTimeWizard Stop xCommand SystemUnit Notifications RemoveAll Clears the list of system notifications that are reported by xStatus SystemUnit Notifications Text Type Requires user role ADMIN USAGE xCommand SystemUnit Notifications RemoveAll xCommand SystemUnit OptionKey Add Add an option key to support additi...

Page 154: ...t SignInBanner Get Get the custom message set with xCommand SystemUnit SignInBanner Set Requires user role ADMIN USAGE xCommand SystemUnit SignInBanner Get xCommand SystemUnit SignInBanner Set Set a sign in banner with a custom message on the system s user interface Use xCommand SystemUnit SignInBanner Set enter Banner text enter enter Requires user role ADMIN USAGE xCommand SystemUnit SignInBanne...

Page 155: ...Password String 0 255 Password to access the server location if needed Forced False True You can force a system to accept a software upgrade immediately without giving users a chance to acknowledge or postpone the update The default value is True Time commands xCommand Time DateTime Get Read the time and date from the system Requires user role ADMIN USER USAGE xCommand Time DateTime Get xCommand T...

Page 156: ... Default is set to Large Type Literal Background Branding HalfwakeBackground HalfwakeBranding Specifies which image to show xCommand UserInterface Branding Updated Updates the chosen branding image Requires user role ADMIN INTEGRATOR USER USAGE xCommand UserInterface Branding Updated Type Type where Type Literal Background Branding HalfwakeBackground HalfwakeBranding Specifies which image to updat...

Page 157: ...The value of the widget The range of values depends on the widget type WidgetId String 0 40 The unique identifier for the widget xCommand UserInterface Extensions Widget SetValue Set the value of the given widget Updates the UserInterface Extensions status tree Returns an error if the value is out of range Requires user role ADMIN INTEGRATOR ROOMCONTROL USAGE xCommand UserInterface Extensions Widg...

Page 158: ...e Message Prompt Clear FeedbackId FeedbackId where FeedbackId String 0 255 The FeedbackId corresponds to the FeedbackId given by the xCommand Message Prompt Display command xCommand UserInterface Message Prompt Display Display a small window on screen with a title text and up to five options for response from the user The message is displayed on screen until the user gives a response or until the ...

Page 159: ...lay Displays an input dialog box to which a user can respond on the Cisco Telepresence Touch 10 and on the main screen of the Cisco DX80 Requires user role ADMIN INTEGRATOR ROOMCONTROL USER USAGE xCommand UserInterface Message TextInput Display Duration Duration FeedbackId FeedbackId InputType InputType KeyboardState KeyboardState Placeholder Placeholder SubmitText SubmitText Text Text Title Title...

Page 160: ...rner The default is set to 0 Duration Integer 0 3600 Set how long in seconds the text line is to be displayed on the screen If set to 0 zero the text line is displayed until a xCommand Message TextLine Clear command has been sent The default is set to 0 xCommand UserInterface Presentation ExternalSource Add Establish and set up an input source that is connected to the video system via an external ...

Page 161: ...xCommand UserInterface Presentation ExternalSource Select SourceIdentifier SourceIdentifier where SourceIdentifier String 0 40 The unique string that identifies this input source It was defined when the source was created with the UserInterface Presentation ExternalSource Add command xCommand UserInterface Presentation ExternalSource State Set Set or change the state of the input source specified ...

Page 162: ...agement RemoteSupportUser Delete Delete the remote support user created with the command xCommand UserManagement RemoteSupportUser Create Requires user role ADMIN USAGE xCommand UserManagement RemoteSupportUser Delete xCommand UserManagement RemoteSupportUser DisablePermanently Disable the creation of new remote support users To enable the remote support user again you must factory reset your syst...

Page 163: ...iteral False True Specifies whether a user s PIN requires changing or not Role Literal Admin Audit Integrator RoomControl User Sets the user s role ShellLogin Literal False True Specifies whether the user should have a shell login or not Username String 0 127 Specifies the user s username YourPassphrase String 0 255 The user s passphrase xCommand UserManagement User Delete Deletes a user from this...

Page 164: ...raseChangeRequired PinChangeRequired PinChangeRequired RemoveRole RemoveRole ShellLogin ShellLogin Username Username YourPassphrase YourPassphrase where Active Literal False True Specifies whether this is an active user or not AddRole Literal Admin Audit Integrator RoomControl User Adds a new role for the specified user ClientCertificateDN String 0 255 Identifies a user who logs in with a client c...

Page 165: ...0 255 xCommand UserManagement User Passphrase Set Set a user passphrase for the specified user You must be logged in as an administrator to set a user passphrase Requires user role ADMIN USAGE xCommand UserManagement User Passphrase Set NewPassphrase NewPassphrase Username Username YourPassphrase YourPassphrase where NewPassphrase String 0 255 Username String 0 127 YourPassphrase String 0 255 Vide...

Page 166: ...ultiple input sources SourceId Integer 1 4 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 xCommand Video Input Source SetActiveConnector Select which connector is active Input Connector 4 DVI I and Connector 5 S Video Composite cannot be active simultaneously Requires user role ADMIN USER USAGE xCommand Video In...

Page 167: ...eo compositions Requires user role ADMIN USER USAGE xCommand Video Matrix Reset Output Output where Output Integer 1 3 Choose the output you want to reset xCommand Video Matrix Swap Swap the content defined with xCommand Video Matrix Assign between two outputs xCommand Video Matrix commands are a smart overlay to the xCommand Video Layout commands to make it easy to do simple video compositions Re...

Page 168: ...rated screen This parameter is only present for video systems with two integrated screens dual screen systems Value Integer 0 100 Select the level xCommand Video Output Monitor Color Blue Set Adjust the level of blue on the monitor Requires user role ADMIN USAGE xCommand Video Output Monitor Color Blue Set Position Position Value Value where Position Left Right Choose whether to apply the command ...

Page 169: ...ht integrated screen This parameter is only present for video systems with two integrated screens dual screen systems Value 4900K 5500K 6500K 7200K 9300K 10500K 12000K User xCommand Video Output Monitor Contrast Set Adjust the contrast level on the monitor Requires user role ADMIN USAGE xCommand Video Output Monitor Contrast Set Position Position Value Value where Position Left Right Choose whethe...

Page 170: ...ight Choose whether to apply the command to the left or right integrated screen This parameter is only present for video systems with two integrated screens dual screen systems xCommand Video Output Monitor Sharpness Set Adjust the image sharpness on the monitor Requires user role ADMIN USAGE xCommand Video Output Monitor Sharpness Set Position Position Value Value where Position Left Right Choose...

Page 171: ...resentation to be displayed in a small picture on screen xCommand Video Selfview Set Sets self view on off and specifies its size and position If the parameter is not specified current value is used Requires user role ADMIN USER USAGE xCommand Video Selfview Set Mode Mode FullscreenMode FullscreenMode PIPPosition PIPPosition OnMonitorRole OnMonitorRole where Mode On Off Selfview is set to on or of...

Page 172: ...eference Guide CE9 2 NOVEMBER 2017 Copyright 2017 Cisco Systems Inc All rights reserved 172 Cisco TelePresence MX700 and MX800 API Reference Guide Chapter 5 xStatus commands Introduction About the API xConfiguration Appendices xCommand xStatus xStatus ...

Page 173: ...nput n Gain 182 xStatus Audio Volume 182 xStatus Audio VolumeMute 182 Bookings status 182 xStatus Bookings Current Id 182 Call status 183 xStatus Call n AnswerState 183 xStatus Call n AttendedTransferFrom 183 xStatus Call n CallbackNumber 183 xStatus Call n CallType 183 xStatus Call n DeviceType 183 xStatus Call n Direction 183 xStatus Call n DisplayName 184 xStatus Call n Duration 184 xStatus Cal...

Page 174: ...lities FECC NumberOfSources 191 xStatus Conference Call n Capabilities FECC Source n Name 192 xStatus Conference Call n Capabilities FECC Source n Options 192 xStatus Conference Call n Capabilities FECC Source n SourceId 192 xStatus Conference Call n Capabilities Hold 192 xStatus Conference Call n Capabilities IxChannel Status 192 xStatus Conference Call n Capabilities Presentation 192 xStatus Con...

Page 175: ...4 xStatus Network 1 CDP PortID 204 xStatus Network 1 CDP PrimaryMgmtAddress 205 xStatus Network 1 CDP SysName 205 xStatus Network 1 CDP SysObjectID 205 xStatus Network 1 CDP Version 205 xStatus Network 1 CDP VoIPApplianceVlanID 205 xStatus Network 1 CDP VTPMgmtDomain 205 xStatus Network 1 DNS Domain Name 206 xStatus Network 1 DNS Server 1 5 Address 206 xStatus Network 1 Ethernet MacAddress 206 xSt...

Page 176: ...ion 217 xStatus SIP Registration n Reason 218 xStatus SIP Registration n Status 218 xStatus SIP Registration n URI 218 xStatus SIP Secure 218 xStatus SIP Verified 219 Standby status 219 xStatus Standby PowerSave State 219 xStatus Standby State 219 SystemUnit status 220 xStatus SystemUnit Hardware Module CompatibilityLevel 220 xStatus SystemUnit Hardware Module SerialNumber 220 xStatus SystemUnit H...

Page 177: ...EC Name 229 xStatus Video Output Connector n ConnectedDevice CEC PowerControl 229 xStatus Video Output Connector n ConnectedDevice CEC PowerStatus 229 xStatus Video Output Connector n ConnectedDevice CEC VendorId 229 xStatus Video Output Connector n ConnectedDevice Name 229 xStatus Video Output Connector n ConnectedDevice PreferredFormat 230 xStatus Video Output Connector n ConnectedDevice ScreenS...

Page 178: ...enceDelay 120 end xStatus Audio Input LocalInput n AGC Shows the AGC Automatic Gain Control mode on the local input You can run the command xStatus Audio Input LocalInput to find the identity n of the input Requires user role ADMIN USER Value space of the result returned On Off Example xStatus Audio Input LocalInput 1 AGC s Audio Input LocalInput 1 AGC On end xStatus Audio Input LocalInput n Chann...

Page 179: ... Input LocalInput to find the identity n of the input Requires user role ADMIN USER Value space of the result returned On Off Example xStatus Audio Input LocalInput 1 Mute s Audio Input LocalInput 1 Mute Off end xStatus Audio Input LocalInput n Name Shows the name of the local input A local input is a mix of input connectors You can run the command xStatus Audio Input LocalInput to find the identi...

Page 180: ... run the command xStatus Audio Output LocalOutput to find the identity n of the output Requires user role ADMIN USER Value space of the result returned 1 2 Example xStatus Audio Output LocalOutput 4 Channels s Audio Output LocalOutput 4 Channels 1 end xStatus Audio Output LocalOutput n Connector n Lists the connectors that are attached to the local output You can run the command xStatus Audio Outp...

Page 181: ...he command xStatus Audio Output LocalOutput to find the identity n of the output Requires user role ADMIN USER Value space of the result returned String Example xStatus Audio Output LocalOutput 4 Name s Audio Output LocalOutput 4 Name MyLocalOutput1 end xStatus Audio Output LocalOutput n VolumeControlled Shows whether this output s volume is controlled by global audio control Off or if it is at th...

Page 182: ...utput 9 Input 1 Gain s Audio Output RemoteOutput 9 Input 1 Gain 0 end xStatus Audio Volume Shows the volume level dB of the loudspeaker output Requires user role ADMIN INTEGRATOR USER Value space of the result returned 0 100 Example xStatus Audio Volume s Audio Volume 70 end xStatus Audio VolumeMute Shows whether the endpoint volume is set to mute Requires user role ADMIN USER Value space of the r...

Page 183: ...IN USER Value space of the result returned String Example xStatus Call 27 CallbackNumber s Call 27 CallbackNumber h323 firstname lastname company com end xStatus Call n CallType Shows the call type of the incoming or outgoing call You can run the command xStatus Call to find the call identity Requires user role ADMIN USER Value space of the result returned Video Audio AudioCanEscalate ForwardAllCa...

Page 184: ...cryption Type Shows the encryption type of the call You can run the command xStatus Call to find the call identity Requires user role ADMIN USER Value space of the result returned None Aes 128 Example xStatus Call 27 Encryption Type s Call 27 Encryption Type None end xStatus Call n FacilityServiceId When calling a facility service the facility service id is shown Otherwise the value 0 is returned ...

Page 185: ...OR USER Value space of the result returned Integer Example xStatus Call 27 ReceiveCallRate s Call 27 ReceiveCallRate 4000 end xStatus Call n RemoteNumber Shows the remote far end number or URI of an incoming or outgoing call You can run the command xStatus Call to find the call identity Requires user role ADMIN USER Value space of the result returned String Example xStatus Call 27 RemoteNumber s C...

Page 186: ...ows 0 if no connection is detected Requires user role ADMIN INTEGRATOR USER ROOMCONTROL Value space of the result returned Integer Example xStatus Cameras Camera 1 DetectedConnector s Cameras Camera 1 DetectedConnector 1 end xStatus Cameras Camera n Flip In Flip mode vertical flip the image can be flipped upside down Requires user role ADMIN INTEGRATOR USER ROOMCONTROL Value space of the result re...

Page 187: ...mple xStatus Cameras Camera 1 Position Focus s Camera 1 Position Focus 4597 end xStatus Cameras Camera n Position Lens Shows the camera s current lens position Requires user role ADMIN INTEGRATOR USER ROOMCONTROL Value space of the result returned Literal Default Wide Center Left Right Example xStatus Cameras Camera 1 Position Lens s Cameras Camera 1 Position Lens Center end xStatus Cameras Camera...

Page 188: ...OR USER ROOMCONTROL Value space of the result returned String Example xStatus Cameras Camera 1 SoftwareID s Camera 1 SoftwareID S01718 4 0FINAL ID 40063 2014 10 20 end xStatus Cameras PresenterTrack Availability Shows whether presenter tracking is available The result Off means presenter tracking is disabled The result Unavailable means that the tracking is not configured correctly camera is disco...

Page 189: ...or Shows the connector number currently chosen by SpeakerTrack Requires user role ADMIN INTEGRATOR USER ROOMCONTROL Value space of the result returned Integer Example xStatus Cameras SpeakerTrack s Cameras SpeakerTrack Availability Available s Cameras SpeakerTrack Status Active end xStatus Cameras SpeakerTrack Availability Shows whether speaker tracking is available Off Speaker tracking is turned ...

Page 190: ...er of simultaneous audio calls that is supported Requires user role ADMIN USER Value space of the result returned Integer Example xStatus Capabilities Conference MaxAudioCalls s Capabilities Conference MaxAudioCalls 4 end xStatus Capabilities Conference MaxCalls Shows the the maximum number of simultaneous calls Requires user role ADMIN USER Value space of the result returned 0 5 Example xStatus C...

Page 191: ...Conference Call 4 Capabilities FarendMessage Mode Off end xStatus Conference Call n Capabilities FECC Mode Shows whether or not you have permission to control the input sources at a far end site On Far end input source control is permitted Off Far end input source control is not permitted Requires user role ADMIN USER Value space of the result returned On Off Example xStatus Conference Call 2 Capa...

Page 192: ...e that can be connected at a far end site Requires user role ADMIN USER Value space of the result returned Integer Example xStatus Conference Call 2 Capabilities FECC Source 1 SourceId s Conference Call 2 Capabilities FECC Source 1 SourceId 6 end xStatus Conference Call n Capabilities Hold Indicates whether the far end site can be placed on hold or not Requires user role ADMIN USER Value space of ...

Page 193: ...ference Call 2 MicrophonesMuted True end xStatus Conference Call n SoftwareID Shows the ID of the software running of the video system at a far end site 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 xStatus Conference DoNotDisturb Shows whether DoNotDisturb mode is switched on or not Requi...

Page 194: ...identity of the system that sends the presentation Requires user role ADMIN INTEGRATOR USER ROOMCONTROL Value space of the result returned Integer Example xStatus Conference Presentation CallId s Conference Presentation CallId 0 end xStatus Conference Presentation LocalInstance n SendingMode Shows whether a presentation source is shared locally or with a remote participant There can be multiple lo...

Page 195: ...nd Diagnostics status xStatus Diagnostics Message n Description Shows a description of the current diagnostics alerts Requires user role ADMIN USER Value space of the result returned String Example xStatus Diagnostics Message Description s DiagnosticsResult Message 1 Description IP configuration incomplete end xStatus Diagnostics Message n Level Shows the level of importance of the diagnostics mes...

Page 196: ...ted NetworkQuality NTPStatus OSDVideoOutput OutputConnectorLocations ProvisioningDeveloperOptions ProvisioningStatus SIPEncryption SIPListenPortAndOutboundMode SIPProfileRegistration SIPProfileType SelectedVideoInputSourceConnected SipIceAndAnatConflict SIPListenPortAndRegistration TCPMediaFallback TemperatureCheck TLSVerifyRequiredCerts TouchPanelConnection ControlSystemConnection TurnBandwidth M...

Page 197: ...he IP address of the gatekeeper where the system is registered Requires user role ADMIN USER Value space of the result returned String Example xStatus H323 Gatekeeper Address s H323 Gatekeeper Address 192 0 1 20 end xStatus H323 Gatekeeper Port Shows the port which is used when connecting to on the gatekeeper Requires user role ADMIN USER Value space of the result returned Integer Example xStatus ...

Page 198: ...H323 Mode Status When H 323 is set to On and there is no conflict between H 323 Mode configuration and the rest of the system settings SIP is enabled When H 323 Mode is set to On and SIP is enabled on a system that does not support the two simultaneously Not available When a system does not support H 323 Requires user role ADMIN USER Value space of the result returned String Example xStatus H323 M...

Page 199: ...orm Resource Locator of the HTTP server There can be up to three HTTP servers specified by the URL 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 MediaChannels status xStatus MediaChannels Call n Channel n Audio Channels Shows the number of incoming or outgoing au...

Page 200: ...rd for audio compression Requires user role ADMIN USER Value space of the result returned AACLD G711A G711Mu G722 G7221 G7221C G723_1 G728 G729 G729A G729AB Off Opus Example xStatus MediaChannels Call 27 Channel 327 Audio Protocol s MediaChannels Call 27 Channel 327 Audio Protocol AACLD end xStatus MediaChannels Call n Channel n Direction Shows the direction of the call Incoming The call is an inc...

Page 201: ...t returned Integer Example xStatus MediaChannels Call 27 Channel 327 NetStat LastIntervalLost s MediaChannels Call 27 Channel 327 NetStat LastIntervalLost 0 end xStatus MediaChannels Call n Channel n NetStat LastIntervalReceived Shows the number of packets received for audio video or data during the last interval on the incoming or outgoing channels Requires user role ADMIN USER Value space of the...

Page 202: ... 27 Channel 327 ParticipantId end xStatus MediaChannels Call n Channel n Type Shows the media type on the incoming or outgoing channel Audio The media type on the incoming or outgoing channel is audio Video The media type on the incoming or outgoing channel is video Data The media type on the incoming or outgoing channel is data Requires user role ADMIN USER Value space of the result returned Audi...

Page 203: ...for video compression HEVC The HEVC H 265 algorithm MPEG H part 2 is an ITU T and ISE IEC standard for video compression JPEG The JPEG algorithm is an ISO IEC standard for video compression MP4V The MP4V format is an ISO IEC file format for video compression Off No video Requires user role ADMIN USER Value space of the result returned H261 H263 H263p H263pp H264 HEVC JPEG MP4V Off Example xStatus ...

Page 204: ...r role ADMIN USER Value space of the result returned String Example xStatus Network CDP DeviceId s Network 1 CDP DeviceId 123456 company com end xStatus Network 1 CDP Duplex Indicates the status duplex configuration of the CDP broadcast interface Used by network operators to diagnose connectivity problems between adjacent network elements Requires user role ADMIN USER Value space of the result ret...

Page 205: ...1 CDP SysObjectID end xStatus Network 1 CDP Version Returns information about the software release version the switch is running Requires user role ADMIN USER Value space of the result returned String Example xStatus Network 1 CDP Version s Network 1 CDP Version Cisco IOS Software C3560CX Software C3560CX UNIVERSALK9 M Version 15 2 3 E RELEASE SOFTWARE fc4 Technical Support http www cisco com tech...

Page 206: ...er role ADMIN USER Value space of the result returned String Example xStatus Network 1 Ethernet MacAddress s Network 1 Ethernet MacAddress 00 50 60 02 FD C7 end xStatus Network 1 Ethernet Speed Shows the Ethernet speed in Mbps The speed can be in full duplex or half duplex Requires user role ADMIN USER Value space of the result returned 10half 10full 100half 100full 1000full Example xStatus Networ...

Page 207: ...iquely identifies this system Requires user role ADMIN USER Value space of the result returned String Example xStatus Network 1 IPv6 Address s Network 1 IPv6 Address end xStatus Network 1 IPv6 Gateway Shows the address of the IPv6 gateway Requires user role ADMIN USER Value space of the result returned String Example xStatus Network 1 IPv6 Gateway s Network 1 IPv6 Gateway end xStatus Network 1 VLA...

Page 208: ...g 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 xStatus NetworkServices NTP Status Returns the status of the endpoints synchronizing with the NTP server Discarded The NTP result has been discarded Synced The system is in sync with the NTP server NotSync...

Page 209: ...Name s Peripherals ConnectedDevice 1007 Name Cisco TelePresence Touch end xStatus Peripherals ConnectedDevice n SoftwareInfo Shows information of the software version running on the connected device Requires user role ADMIN INTEGRATOR USER ROOMCONTROL Value space of the result returned String Example xStatus Peripherals ConnectedDevice 1007 SoftwareInfo s Peripherals ConnectedDevice 1007 SoftwareI...

Page 210: ...ng status xStatus Provisioning CUCM ExtensionMobility Enabled Shows if Extension Mobility is enabled for a CUCM registered device Requires user role ADMIN USER Value space of the result returned True False Example xStatus Provisioning CUCM ExtensionMobility Enabled s Provisioning CUCM ExtensionMobility Enabled False end xStatus Provisioning CUCM ExtensionMobility LastLoggedInUserId Returns the use...

Page 211: ...e ADMIN USER Value space of the result returned String Example xStatus Provisioning Software Current URL s Provisioning Software Current URL http s52020ce8 _ 0 _ 0 pkg end xStatus Provisioning Software Current VersionId Shows the version ID of the current software Requires user role ADMIN USER Value space of the result returned String Example xStatus Provisioning Software Current VersionId s Provi...

Page 212: ...g Software UpgradeStatus SessionId end xStatus Provisioning Software UpgradeStatus Status Shows the status of the software upgrade Requires user role ADMIN USER Value space of the result returned None InProgress Failed InstallationFailed Succeeded Example xStatus Provisioning Software UpgradeStatus Status s Provisioning Software UpgradeStatus Status None end xStatus Provisioning Software UpgradeSt...

Page 213: ...tus Provisioning Status s Provisioning Status Provisioned end Proximity status xStatus Proximity Services Availability Shows whether proximity services are available on the endpoint Available Proximity mode has been enabled with the command xConfiguration Proximity Mode and one or more of the proximity services have been enabled with xConfiguration Proximity Services commands Disabled Proximity mo...

Page 214: ...ople present in the room Requires user role ADMIN USER Value space of the result returned Yes No Unknown Example xStatus RoomAnalytics PeoplePresence s RoomAnalytics PeoplePresence No end Security status xStatus Security FIPS Mode Shows the FIPS mode status Requires user role ADMIN USER Value space of the result returned On Off Example xStatus Security FIPS Mode s Security FIPS Mode Off end xStatu...

Page 215: ...USER Value space of the result returned NonPersistent Persistent Example xStatus Security Persistency DHCP s Security Persistency DHCP Persistent end xStatus Security Persistency InternalLogging Shows whether internal logging is set to persistent or non persistent mode Persistent is the default mode Requires user role ADMIN USER Value space of the result returned NonPersistent Persistent Example x...

Page 216: ...hentication protocol Off No authentication mechanism is used Requires user role ADMIN USER Value space of the result returned Digest Off Example xStatus SIP Authentication s SIP Authentication Off end xStatus SIP CallForward DisplayName Returns the URI that is displayed on the user interface for the forwarded call Requires user role ADMIN USER Value space of the result returned String Example xSta...

Page 217: ... is active DNSFailed The attempt to establish communication to the DNS server failed Off There is no communication between the endpoint and the SIP Proxy Timeout The attempt to establish communication to the SIP Proxy timed out UnableTCP The system is unable to use TCP as the transport method UnableTLS The system is unable to use TLS as the transport method Unknown The status of the communication ...

Page 218: ...ot registered to any SIP Proxy Registered The system is registered to the SIP Proxy Registering The system is in the process of registering to the SIP Proxy Requires user role ADMIN USER Value space of the result returned Deregister Failed Inactive Registered Registering Example xStatus SIP Registration 1 Status s SIP Registration 1 Status Registered end xStatus SIP Registration n URI Shows the UR...

Page 219: ...Example xStatus SIP Verified s SIP Verified False end Standby status xStatus Standby PowerSave State Shows whether the system is in power save mode or not Active It is out of office hours so the video system is in power save mode Deactivating The video system is in the process of waking up from power save mode Inactive It is regular working hours so the video system is not in power save mode Disab...

Page 220: ...s SystemUnit Hardware Module SerialNumber Shows the serial number of the hardware module in the codec Requires user role ADMIN USER Value space of the result returned String Example xStatus SystemUnit Hardware Module SerialNumber s SystemUnit Hardware Module SerialNumber FTT123456A1 end xStatus SystemUnit Hardware Monitoring Fan n Status The feedback shows the speed rpm for the specified fan Requi...

Page 221: ...tOK FactoryResetFailed SoftwareUpgradeOK SoftwareUpgradeFailed RebootRequired Other Example xStatus SystemUnit Notifications Notification 1 Type s SystemUnit Notifications Notification 1 Type SoftwareUpgradeOK end xStatus SystemUnit ProductId Shows the product identity Requires user role ADMIN USER Value space of the result returned String Example xStatus SystemUnit ProductId s SystemUnit ProductI...

Page 222: ...e result returned False True Example xStatus SystemUnit Software OptionKeys MultiSite s SystemUnit Software OptionKeys MultiSite true end xStatus SystemUnit Software OptionKeys RemoteMonitoring Shows whether the system has the remote monitoring option key installed Remote monitoring option key enables snapshots from the web interface and from a remote paired Touch 10 Requires user role ADMIN USER ...

Page 223: ...uires user role ADMIN INTEGRATOR USER ROOMCONTROL Value space of the result returned 0 5 Example xStatus SystemUnit State NumberOfInProgressCalls s SystemUnit State NumberOfInProgressCalls 0 end xStatus SystemUnit State NumberOfSuspendedCalls Shows the number of suspended calls Requires user role ADMIN USER Value space of the result returned 0 5 Example xStatus SystemUnit State NumberOfSuspendedCa...

Page 224: ... xStatus UserInterface ContactInfo Name Returns the system s active contact name The result depends on which protocol if any the system is registered on The automatically set contact name may have been overridden with the command xConfiguration UserInterface ContactInfo Type This results in a diagnostics warning about contact mismatch Requires user role ADMIN USER Value space of the result returne...

Page 225: ...sition Shows the position of the active speaker s image on the screen Requires user role ADMIN INTEGRATOR USER Value space of the result returned UpperLeft UpperCenter UpperRight CenterLeft CenterRight LowerLeft LowerRight Example xStatus Video ActiveSpeaker PIPPosition s Video PIP ActiveSpeaker Position UpperCenter end xStatus Video Input Connector n Connected Shows whether is something is connec...

Page 226: ...nown YC Example xStatus Video Input Connector 1 Type s Video Input Connector 1 Type HDMI end xStatus Video Input MainVideoSource Returns the local video input currently used as the main source The value Composed is returned if the main source is composed of more than one local input The default main video source is set with the xConfiguration Video DefaultMainSource command It can be changed using...

Page 227: ...olution height in pixels for the video input source Requires user role ADMIN INTEGRATOR USER Value space of the result returned 0 3000 Example xStatus Video Input Source 1 Resolution Height s Video Input Source 1 Resolution Height 1080 end xStatus Video Input Source n Resolution RefreshRate Shows the resolution refresh rate Hz for the video input source Requires user role ADMIN INTEGRATOR USER Val...

Page 228: ... Output Connector n Connected Describes whether a device for example a display is connected to the output connector or not When a display enters standby mode the endpoint may not be able to detect it The connector status will then return False Unknown even if the display is physically connected True A device is connected to the video output connector False Nothing is connected to the video output ...

Page 229: ...power on Failed to standby Example xStatus Video Output Connector 1 ConnectedDevice CEC PowerControl s Video Output Connector 1 ConnectedDevice CEC PowerControl Ok end xStatus Video Output Connector n ConnectedDevice CEC PowerStatus Shows the state of the CEC enabled devise connected to the HDMI output This information is only available when the device connected to the HDMI output has the CEC feat...

Page 230: ...t Connector 1 ConnectedDevice ScreenSize s Video Output Connector 1 ConnectedDevice ScreenSize 55 end xStatus Video Output Connector n MonitorRole Describes which video stream is shown on the device that is connected to the video output connector First Second Third The role of the monitor in a multimonitor setup In a singlemonitor setup there is no difference between First Second and Third Present...

Page 231: ...alue space of the result returned HDMI DVI Example xStatus Video Output Connector 1 Type s Video Output Connector 1 Type HDMI end xStatus Video Output Monitor n Backlight Returns the monitors backlight level that has been set with xCommand Video Output Monitor n Backlight Requires user role ADMIN USER Value space of the result returned Integer Example xStatus Video Output Monitor 1 Backlight s Vid...

Page 232: ...ut Monitor Color Select Requires user role ADMIN USER Value space of the result returned 4900 5500 6500 7200 9300 10500 12000 User Example xStatus Video Output Monitor 1 ColorTemperature Selected s Video Output Monitor 1 ColorTemperature Selected 6500 end xStatus Video Output Monitor n Contrast Returns the monitors contrast level that has been set with xCommand Video Output Monitor n Contrast Requ...

Page 233: ...resentation image on the screen Requires user role ADMIN USER Value space of the result returned UpperLeft UpperCenter UpperRight CenterLeft CenterRight LowerLeft LowerRight Example xStatus Video Presentation PIPPosition s Video PIP Presentation Position CenterLeft end xStatus Video Selfview FullscreenMode Shows whether selfview is set on full screen mode or not Requires user role ADMIN INTEGRATOR...

Page 234: ...tus Video Selfview PIPPosition Shows the position of the selfview image on the screen Requires user role ADMIN INTEGRATOR USER Value space of the result returned UpperLeft UpperCenter UpperRight CenterLeft CenterRight LowerLeft LowerRight Example xStatus Video Selfview PIPPosition s Video Selfview PIPPosition LowerRight end Introduction About the API xConfiguration Appendices xCommand xStatus xSta...

Page 235: ... Reference Guide CE9 2 NOVEMBER 2017 Copyright 2017 Cisco Systems Inc All rights reserved 235 Cisco TelePresence MX700 and MX800 API Reference Guide Chapter 6 Appendices Introduction About the API xConfiguration Appendices xCommand xStatus Appendices ...

Page 236: ... contains commands xCommand and configurations xConfiguration that will be executed as part of the start up procedure every time the codec boots A few commands and configurations cannot be placed in a startup script e g xCommand SystemUnit Boot 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 you...

Page 237: ...icense file systemtools network ping hostname Network debug command hostname The IP address or URL of the host systemtools network traceroute hostname Network debug command hostname The IP address or URL of the host systemtools network netstat Network debug command systemtools network addrs Check the systems IP address systemtools network ifconfig Network debug command systemtools pairing unpair R...

Page 238: ...Ns 0 Maximum number of digits in PINs Max consecutive identical characters in passwords 0 Maximum consecutive identical characters in passwords Minimum number of characters in passwords 0 Minimum number of characters in passwords Maxmum number of characters in passwords 0 Maxmum number of characters in passwords Minimum number of lower case letters in passwords 0 Minimum number of lower case lette...

Page 239: ... call was disconnected The value space is OtherLocal LocalDisconnect UnknownRemoteSite LocalBusy LocalReject InsufficientSecurity OtherRemote RemoteDisconnect RemoteBusy RemoteRejected RemoteNoAnswer CallForwarded NetworkRejected CauseString Describes the Cause Code CauseCode The disconnect Cause Codes are defined in SIP and Q 850 CauseOrigin SIP Q 850 internal Example xEvent DisconnectEvent e Cal...

Page 240: ...configurations required to get the system up and running Administrator guide Information required to administer your product Administering CE Endpoints on CUCM Tasks to 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 Quick reference guides How to use the product Reference Guides Command re...

Page 241: ...G USAGE OR TRADE PRACTICE IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT SPECIAL CONSEQUENTIAL OR INCIDENTAL DAMAGES INCLUDING WITHOUT LIMITATION LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL EVEN IF CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES Any Internet Protocol IP addresses and phone numbers us...

Search results

Summary of Contents for TelePresence MX700

Reviews:

Related manuals for TelePresence MX700

Brands by name

Popular brands

Cisco TelePresence MX700, Reference Manual

Search results

Summary of Contents for TelePresence MX700

Reviews:

Related manuals for TelePresence MX700

Brands by name

Popular brands