Download  Print this page

Advertisement

Cisco TelePresence MX700 and MX800
API Reference Guide
Introduction
About the API
xConfiguration
xCommand
xStatus
Appendices
Collaboration Endpoint Software 9.2
NOVEMBER 2017
Application Programming Interface (API)
Reference Guide
Cisco TelePresence MX700 and MX800
D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017.
1
Copyright © 2017 Cisco Systems, Inc. All rights reserved.

Advertisement

   Summary of Contents for Cisco MX700

  • Page 1 Appendices Collaboration Endpoint Software 9.2 NOVEMBER 2017 Application Programming Interface (API) Reference Guide Cisco TelePresence MX700 and MX800 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 2: Table Of Contents

    User documentation on the Cisco web site ......240 Status ..................27 Multiline commands ..............28 Synchronous API calls ............29 Events ...................30 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 3: Introduction

    Cisco TelePresence MX700 and MX800 API Reference Guide  Introduction Introduction About the API xConfiguration xCommand xStatus Appendices Chapter 1 Introduction D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 4: We Recommend You Visit Our Web Site Regularly For Updated About This Guide

    Cisco web site appendix. the user role (integrator and roomcontrol) of the local user determines which commands are available. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 5: Go To:http://www.cisco.com/go/mx-docs What's New In Ce9.2

    The wizard in the Settings panel on the Touch 10 user interface helps you to set up the feature and define where the whiteboard area is. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 6 , or Services Add ). You can also upload certificates to a video system from its web interface, as before. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 7 Value space: Auto/Manual NEW: Value space: Auto/AutoLimited/Manual Cameras SpeakerTrack Closeup OLD: User role: ADMIN, INTEGRATOR NEW: User role: ADMIN, INTEGRATOR, USER D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 8 Security Certificates Services Delete Security Certificates Services Show Standby Halfwake SystemUnit ProductPlatform Set UserInterface Branding Delete UserInterface Branding Get D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 9 Removed: Camera Camera PositionReset Added: CameraId: Integer (1..7) OLD: User role: ADMIN, USER NEW: User role: ADMIN, INTEGRATOR, USER D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 10 Video Input SetMainVideoSource Added: Layout: Equal / PIP OLD: User role: INTEGRATOR, USER NEW: User role: ADMIN, INTEGRATOR, USER D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 11 Video Input MainVideoSource OLD: Value space: Integer NEW: Value space: 1 / 2 / 3 / 4 / Composed D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 12: What's New In Ce9.1

    The feature is based on ultrasound, and it does not keep record of who was in the room, only whether or not the room is in use. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 13 OLD: Valuespace: String(0, 32) NEW: Valuespace: String(0, 50) Video Input Connector [n] PresentationSelection OLD: Valuespace: AutoShare/Manual/OnConnect NEW: Valuespace: AutoShare/Desktop/Manual/OnConnect D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 14 NEW: User role: ADMIN, USER SystemUnit FactoryReset (All products) OLD: Keep: LocalSetup/Network/Spark/Provisioning NEW: Keep: LocalSetup/Network/Spark/Provisioning/ SerialPort/Certificates (not in use) D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 15 ConfigurationFile / DefaultCallProtocolRegistered / EthernetDuplexMatches / FanStatus / PresenterTrack / H320GatewayStatus / H323GatekeeperStatus / HasValidReleaseKey / IpCameraStatus / IPv4Assignment / IPv6Assignment / IPv6Mtu / ISDNLinkCompatibility D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 16: What's New In Ce9.0

    Standby WakeupOnMotionDetection You can’t manually place the system in standby when this feature is enabled. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 17 Audio Input Line [n] * Video Monitors Audio Input Microphone [n] * Video Output Connector [n] CEC Mode Audio MicrophoneReinforcement * D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 18 UserInterface Message Prompt Response UserInterface Message TextLine Clear xCommand with INTEGRATOR user role UserInterface Message TextLine Display Audio Microphones Mute D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 19 InvalidSIPTransportConfig, LockDown, RoomControl, MediaBlockingDetected, Audio Volume NetLinkStatus, NetSpeedAutoNegotiated, NetworkQuality, NTPStatus, OSDVideoOutput, OutputConnectorLocations, ProvisioningStatus, SIPEncryption, Call[n] FacilityServiceId SIPListenPortAndOutboundMode, SIPProfileRegistration, SIPProfileType, SelectedVideo Call[n] ReceiveCallRate D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 20 GPIO Pin[n] State Video Output Connector[n] ConnectedDevice CEC[n] PowerControl Peripherals ConnectedDevice[n] HardwareInfo Video Output Connector[n] ConnectedDevice CEC[n] Peripherals ConnectedDevice[n] ID D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 21: About The Api

    API Reference Guide  Introduction About the API About the API xConfiguration xCommand xStatus Appendices Chapter 2 About the API D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 22: Api Fundamentals

    GET methods are used to execute commands and get feedback from the codec. This is described in ”Using HTTP” on page 33 in this document. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 23: Rs-232 / Serial Connection

    If a video system is registered to Cisco’s cloud service (Cisco Spark), only local users with the INTEGRATOR and ROOMCONTROL user roles are available. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 24: Api Output

    To set output mode to XML, issue the command: </Set> xPreferences outputmode xml </Volume> </Audio> </Command> To revert to terminal mode, issue the command: xPreferences outputmode terminal D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 25: Using The Command Line

    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 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 26: Command Line Shortcuts

    *s Video Output Connector 2 Resolution Width: 1280 xcommand dial number: foo@bar.org *s Video Output Connector 3 Resolution Width: 1280 xCommand Dial Number: foo@bar.org ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 27: Commands

    ‘:’. xConfiguration H323 Profile 1 H323Alias ID Result: *c xConfiguration H323 Profile 1 H323Alias ID: “changed@company.com” **end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 28: Multiline Commands

    The multiline commands are marked as multiline in xCommand overview section in this guide. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 29: Synchronous Api Calls

    ID on the response with the corresponding ID in the command queue. This enables matching the original request </Video> with the specific response. </Configuration> </XmlDoc> D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 30: Events

    *e CallSuccessful CallId: 132 Protocol: “h223” Direction: “outgoing” CallRate: 768 RemoteURI: “h223:integratorHQ@company.com” EncryptionIn: “Off” EncryptionOut: “Off” ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 31: Feedback Mechanism

    Video Input Connector 3 Name *c xConfiguration Video Input Connector 3 Name: “NameC” ** end Equivalent feedback expression xFeedback register /Configuration/Video/Input/ Connector[@item=’3’]/Name D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 32: Terminal Connections

    Write in: ** end Result: D: List the new feedback expressions. xFeedback list Write in: /Configuration/Video/MainVideoSource Result: ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 33: Http Xmlapi Authentication

    HTTP/1.1 204 No Content GET /configuration.xml HTTP/1.1 Server: nginx/1.8.0 Cookie: SessionId=f08102c8ce5aaf8fba23a7238cc2ef46 Connection: keep-alive 4b990e18bfbb7fb048820c0e28955c54 Set-Cookie: SessionId=; Max-Age=0; Path=/; HttpOnly D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 34: Getting Status And Configurations

    Response <SystemUnit> HTTP/1.1 200 OK <Name>newName</Name> Content-Type: text/xml </SystemUnit> Content-Length: 91 </Configuration> <?xml version=”1.0”?> <Command> <CameraPositionSetResult item=”1” status=”OK”/> </Command> D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 35: Feedback From Codec Over Http

    CallDisconnect</Expression> Expression: <S: 1, 255> <Expression item=”3”>/Status/Call</ Expression: <S: 1, 255> Expression> Expression: <S: 1, 255> </Register> </HttpFeedback> </Command> D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 36: Translating From Terminal Mode To Xml

    Example 2: Assigning volume level Terminal xCommand Audio Volume Set Level: 50 <Command> <Audio> <Volume> <Set command=”True”> <Level>50</Level> </Set> </Volume> </Audio> </Command> D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 37: Dos And Don'ts

    Although the amount of feedback may seem fine in the current version, the amount of feedback may grow in future releases. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 38: Xconfiguration Commands

    Cisco TelePresence MX700 and MX800 API Reference Guide  Introduction About the API xConfiguration xConfiguration xCommand xStatus Appendices Chapter 3 xConfiguration commands D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 39: Description Of The Xconfiguration Commands

    Audio Input Microphone [1..8] VideoAssociation VideoInputSource ........ 49 xConfiguration Cameras SpeakerTrack Closeup ..................55 xConfiguration Audio Input Microphone [1..8] Level .................. 49 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 40 Network [1] QoS Diffserv NTP ...................73 xConfiguration H323 NAT Address ......................63 xConfiguration Network [1] RemoteAccess Allow ..................73 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 41 Peripherals Profile ControlSystems ................... 81 xConfiguration SIP Authentication Password .................... 88 xConfiguration Peripherals Profile TouchPanels ..................81 xConfiguration SIP DefaultTransport ......................88 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 42 UserInterface KeyTones Mode ...................97 xConfiguration Video Selfview OnCall Mode ...................107 xConfiguration UserInterface Language ....................97 xConfiguration Video Selfview OnCall Duration ..................107 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 43: Audio Configuration

    When set to InCallOnly this will prevent the audio-system from being muted by mistake. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 44: Xconfiguration Audio Microphonereinforcement Gain

    : Integer (-24..0) Select a ringtone from the list. Select a value between -24 and 0, in steps of 1 dB. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 45: Xconfiguration Audio Input Hdmi [n] Mode

    : Unique ID that identifies the audio line input. Range: 1..4 : Integer (1..8) Set the equalizer ID. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 46: Xconfiguration Audio Input Line [1

    (locally and to far end) when the associated video source is presented. The audio will be muted when the video source is not presented. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 47: Xconfiguration Audio Input Line [1

    If the changes in the audio See the Audio Level table in the Physical Interface Guide for Cisco TelePresence SX80 for a conditions are significant, the echo canceller may take a second or two to re-adjust.
  • Page 48: Xconfiguration Audio Input Microphone [1

    On: A video source is associated, and the audio will be muted if the associated video source is not displayed. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 49: Xconfiguration Audio Input Microphone [1..8] Videoassociation

    Define the level of the Microphone input connector. connector can be set to line or microphone mode. See the Audio Level table in the Physical Interface Guide for Cisco TelePresence SX80 for a Requires user role: ADMIN, INTEGRATOR complete overview of the values represented in dB.
  • Page 50: Xconfiguration Audio Output Line [1..6] Channel

    : Unique ID that identifies the audio line output. Range: 1..6 The delay in milliseconds. : Integer (1..8) Set the equalizer ID. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 51: Xconfiguration Audio Output Line [1

    This setting applies to the Intelligent Proximity feature. Set the maximum volume of the ultra- sound pairing message. See the Audio Level table in the Physical Interface Guide for Cisco TelePresence SX80 for a complete overview of the values represented in dB.
  • Page 52: Cameras Configuration

    Typical situations where the codec does not receive EDID information are: when you connect DefaultMode : Off/On a Cisco TelePresence Precision 60 camera using 3G-SDI; when you connect a Cisco Off: Turn off the camera backlight compensation. TelePresence Precision 40 (Cisco TelePresence PrecisionHD 1080p4xS2) camera; when you use an HDMI repeater that does not pass on EDID information.
  • Page 53: Xconfiguration Cameras Camera [1..7] Brightness Defaultlevel

    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. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 54: Xconfiguration Cameras Camera [1..7] Gamma Mode

    Manual: Enables manual control of the camera white balance. The white balance level is set using the Cameras Camera [n] Whitebalance Level setting. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 55: Xconfiguration Cameras Camera [1..7] Whitebalance Level

    Auto: The system will zoom in on the person speaking. Off: The system will keep all the persons in the room in the camera framing at all times. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 56: Xconfiguration Cameras Speakertrack Trackingmode

    Cameras SpeakerTrack ConnectorDetection CameraRight Not applicable in this version. USAGE: xConfiguration Cameras SpeakerTrack ConnectorDetection CameraRight: CameraRight where D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 57: Conference Configuration

    If multiple protocols are available, the order of priority is: 1) SIP; 2) H323; 3) H320. If the Requires user role: ADMIN system cannot register, the auto-selection chooses H323. Default value: Off H320: All calls are set up as H.320 calls (only applicable if connected to Cisco TelePresence ISDN Link). USAGE: xConfiguration Conference AutoAnswer Mute: Mute H323: All calls are set up as H.323 calls.
  • Page 58: Xconfiguration Conference Defaultcall Rate

    (pan, tilt, zoom). You will still be able to control your camera and select your video sources as normal. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 59: Xconfiguration Conference Maxreceivecallrate

    Default value: 6000 USAGE: xConfiguration Conference MaxTotalTransmitCallRate: MaxTotalTransmitCallRate where MaxTotalTransmitCallRate : Integer (64..6000) The maximum transmit call rate (kbps). D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 60: Xconfiguration Conference Multistream Mode

    OutputStandbyActive: The pin is activated when the system is in standby mode, and deacti¬vated when no longer in standby. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 61: H323 Configuration

    H323 Gatekeeper Address must also be configured. xConfiguration H323 Authentication LoginName: "LoginName" where LoginName : String (0, 50) The authentication login name. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 62: Xconfiguration H323 Encryption Keysize

    The H.323 Alias ID. Example: "firstname.lastname@company.com", "My H.323 Alias ID" Address : String (0, 255) A valid IPv4 address, IPv6 address or DNS name. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 63: Xconfiguration H323 Nat Mode

    "My IP Address: 10.0.2.1". If the H323 NAT Address is wrong or not set, H.323 calls cannot be set up. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 64: Macros Configuration

    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. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 65: Xconfiguration Network [1] Ieee8021x Mode

    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. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 66: Xconfiguration Network [1] Ieee8021x Password

    The 802.1X Anonymous ID string. Ttls : Off/On Off: The EAP-TTLS protocol is disabled. On: The EAP-TTLS protocol is enabled (default). D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 67: Xconfiguration Network [1] Ieee8021x Eap Tls

    Network [1] IPv4 Assignment Define the Peap (Protected Extensible Authentication Protocol) mode. Authenticates LAN clients without the need for client certificates. Developed by Microsoft, Cisco and RSA Security. Define how the system will obtain its IPv4 address, subnet mask and gateway address. This setting applies only to systems on IPv4 networks.
  • Page 68: Xconfiguration Network [1] Ipv4 Address

    DHCPv6 server. The Network IPv6 DHCPOptions setting determines which method to use. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 69: Xconfiguration Network [1] Ipv6 Address

    : Index that identifies the network. Range: 1..1 A valid IPv6 address. : Integer (576..1500) Set a value for the MTU (bytes). D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 70: Xconfiguration Network [1] Qos Mode

    Signalling, Network QoS Diffserv ICMPv6 and Network QoS Diffserv NTP settings are higher the priority. The default value is 0 (best effort). used to prioritize packets. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 71: Xconfiguration Network [1] Qos Diffserv Video

    The default value is 0 (best effort). higher the priority. The default value is 0 (best effort). D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 72: Xconfiguration Network [1] Qos Diffserv Signalling

    The default value is 0 (best effort). higher the priority. The default value is 0 (best effort). D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 73: Xconfiguration Network [1] Qos Diffserv Ntp

    : Index that identifies the network. Range: 1..1 Allow : String (0, 255) A valid IPv4 address or IPv6 address. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 74: Xconfiguration Network [1] Vlan Voice Mode

    NetworkServices CDP Mode: Mode Mode : Auto/Manual/Off where Auto: The Cisco Discovery Protocol (CDP), if available, assigns an id to the voice VLAN. Mode : Off/On If CDP is not available, VLAN is not enabled. Off: The CDP daemon is disabled.
  • Page 75: Xconfiguration Networkservices Http Mode

    The HTTP Proxy Settings are available from the user interface when the system is provisioned xConfiguration NetworkServices HTTP Proxy Password: "Password" to Cisco Spark. The HTTP proxy settings makes it possible to onboard a video system behind a HTTP proxy to Spark.
  • Page 76: Xconfiguration Networkservices Http Proxy Mode

    NetworkServices HTTP Proxy Mode xConfiguration NetworkServices HTTPS Server MinimumTLSVersion The HTTP proxy for Cisco Spark can be set up manually or turned off. Set the lowest version of the TLS (Transport Layer Security) protocol that is allowed. Requires user role: ADMIN, USER...
  • Page 77: Xconfiguration Networkservices Https Verifyservercertificate

    Authority (CA). This requires that a list of trusted CAs are uploaded to the system in Address advance. : String (0, 255) A valid IPv4 address, IPv6 address or DNS name. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 78: Xconfiguration Networkservices Sip Mode

    SNMP Agent in the codec. The default password is Requires user role: ADMIN "public". If you have the Cisco TelePresence Management Suite (TMS) you must make sure the same SNMP Community is configured there too. NOTE: The SNMP Community password is Default value: ReadOnly case sensitive.
  • Page 79: Xconfiguration Networkservices Snmp Systemcontact

    On: UPnP is enabled. The video system advertises its presence until the timeout period Mode : Off/On expires. Off: The SSH protocol is disabled. On: The SSH protocol is enabled. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 80: Xconfiguration Networkservices Welcometext

    Minimum1: At least one camera should be connected to the video system. 0-7: Select the number of cameras that are expected to be connected to the video system. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 81: Phonebook Configuration

    Requires user role: ADMIN xConfiguration Peripherals Profile TouchPanels Default value: Off Define the number of Cisco Touch controllers that are expected to be connected to the video USAGE: system. This information is used by the video system's diagnostics service. If the number of...
  • Page 82: Xconfiguration Phonebook Server [1] Url

    If the NAPTR responses have the "e" flag, external configurations will be requested. Otherwise internal configurations will be requested. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 83: Xconfiguration Provisioning Mode

    A valid password. Management System). VCS: Push configurations to the video system from VCS (Cisco TelePresence Video Communication Server). D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 84: Xconfiguration Provisioning Httpmethod

    HTTP: Send requests via HTTP. Address : String (0, 64) A valid IPv4 address, IPv6 address or DNS name. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 85: Xconfiguration Provisioning Externalmanager Path

    When the video system emits ultrasound, Proximity clients can detect that they are close to the Default value: "" 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 USAGE: Proximity services.
  • Page 86: Xconfiguration Proximity Services Contentshare Fromclients

    : Enabled/Disabled Enabled: Content sharing to a Proximity client is enabled. Disabled: Content sharing to a Proximity client is disabled. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 87: Serialport Configuration

    USAGE: xConfiguration SerialPort BaudRate: BaudRate where BaudRate : 9600/19200/38400/57600/115200 Set a baud rate from the baud rates listed (bps). D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 88: Sip Configuration

    SIP DisplayName: "DisplayName" where DisplayName : String (0, 550) The name to be displayed instead of the SIP URI. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 89: Xconfiguration Sip Ice Mode

    Rflx: Send media to the video system's public IP address, as seen by the TURN server. Relay: Send media to the IP address and port allocated on the TURN server. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 90: Xconfiguration Sip Turn Server

    Requires user role: ADMIN Default value: "" USAGE: xConfiguration SIP Turn Password: "Password" where Password : String (0, 128) A valid password. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 91: Standby Configuration

    PrivacyPosition: When the video system enters standby, the camera turns to a sideways Set the standby delay (minutes). position for privacy. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 92: Xconfiguration Standby Wakeupaction

    Off: The wake up on motion detection is disabled. On: When people walk into the room the system will automatically wake up from standby. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 93: Systemunit Configuration

    MM_DD_YY: The date January 30th 2010 will be displayed: 01.30.10 YY_MM_DD: The date January 30th 2010 will be displayed: 10.01.30 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 94: Xconfiguration Time Zone

    Australia/Sydney, Australia/Tasmania, Australia/Victoria, Australia/West, Australia/ America/Jamaica, America/Jujuy, America/Juneau, America/Kentucky/Louisville, America/ Yancowinna, Brazil/Acre, Brazil/DeNoronha, Brazil/East, Brazil/West, CET, CST6CDT, Canada/ Kentucky/Monticello, America/Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 95: Xconfiguration Time Workday Start

    Mountain, US/Pacific, US/Pacific-New, US/Samoa, UTC, Universal, W-SU, WET, Zulu The working day end time, using the 24-hour clock. Example: "16:00" Select a time zone from the list. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 96: Xconfiguration Time Workweek Firstdayofweek

    DisplayName: Show the system's display name (refer to the SIP DisplayName setting). The last day of the working week. Example: Friday D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 97: Xconfiguration Userinterface Osd Halfwakemessage

    Add a custom message. If you add a space, there will be no visible message. Add an empty string to remove a custom message. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 98: Xconfiguration Userinterface Osd Output

    Locked: Authentication with administrator's username and passphrase is required. A valid IPv4 address, IPv6 address or hostname. Unlocked: No authentication is required. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 99: Xconfiguration Usermanagement Ldap Server Port

    Use the video system’s web interface to manage the list of trusted CAs (see more details in the administrator guide). D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 100: Xconfiguration Usermanagement Ldap Admin Filter

    Group : String (0, 255) The distinguishing name of the AD group. Example: "CN=admin_group, OU=company groups, DC=company, DC=com" D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 101: Video Configuration

    AnalogYPbPr: Set to AnalogYPbPr to force the DVI video input to AnalogYPbPr, as the component (YPbPr) signal cannot be auto detected. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 102: Xconfiguration Video Input Connector [1..5] Inputsourcetype

    : Unique ID that identifies the video input connector. Range: 1..5 as in manual mode. Name : String (0, 50) Name for the video input connector. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 103: Xconfiguration Video Input Connector [1..5] Quality

    Never: The input source is not expected to be used as a presentation source, and will not show up on the user interface. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 104: Xconfiguration Video Output Connector [2] Cec Mode

    On: CEC is enabled. show the presentation. Monitors/outputs with this monitor role are disregarded by the Video Monitors setting. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 105: Xconfiguration Video Output Connector [n] Resolution

    On: The self-view picture will be shown in fullscreen. where DefaultSource : 1/2/3/4 The video input source to use as default presentation source. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 106: Xconfiguration Video Selfview Default Onmonitorrole

    LowerLeft: The self-view PiP will appear in the lower left corner of the screen. LowerRight: The self-view PiP will appear in the lower right corner of the screen. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 107: Xconfiguration Video Selfview Oncall Mode

    : Integer (1..60) Range: Choose for how long self-view remains on. The valid range is between 1 and 60 seconds. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 108: Xcommand Commands

    Cisco TelePresence MX700 and MX800 API Reference Guide  Introduction About the API xConfiguration xCommand xCommand xStatus Appendices Chapter 4 xCommand commands D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 109: Description Of The Xcommand Commands

    Camera Preset Activate ......................124 Call commands ............................118 xCommand Camera Preset ActivateDefaultPosition ................124 xCommand Call Accept..........................118 xCommand Camera Preset Edit .......................125 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 110 Peripherals Pairing Pair ......................139 Dial commands ........................... 133 xCommand Peripherals Pairing Unpair ....................139 xCommand Dial ............................133 xCommand Peripherals Purge .........................139 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 111 Time DateTime Get .......................155 xCommand Security Certificates CA Add ....................148 xCommand Time DateTime Set .......................155 xCommand Security Certificates CA Delete ....................148 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 112 Video PresentationView Set ....................171 xCommand UserManagement RemoteSupportUser DisablePermanently ..........162 xCommand Video Selfview Set ........................ 171 xCommand UserManagement RemoteSupportUser GetState ..............162 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 113: Audio Commands

    The volume for the test signal. In a noisy environment a higher volume gives more reliable and robust results. The default is set to 20. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 114: Xcommand Audio Sound Play

    USAGE: xCommand Audio Sound Stop Requires user role: ADMIN, INTEGRATOR, USER USAGE: xCommand Audio SoundsAndAlerts Ringtone List D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 115: Xcommand Audio Soundsandalerts Ringtone Play

    Choose the number of steps to increase the volume with. One step is 0.5 dB. The default is set to 5. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 116: Xcommand Audio Volume Unmute

    Audio VuMeter StopAll Select the connector type. IncludePairingQuality: Literal (Off / On ) The default is set to Off D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 117: Bookings Commands

    The booking ID of a call or conference. Offset: Integer (0..65534) Offset number of bookings for this search. The default is set to 0. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 118: Xcommand Call Disconnect

    Call command to see the CallId. The default is set to -1. Value: Left/Right/Up/Down/ZoomIn/ZoomOut Select the action for how to move the camera. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 119: Xcommand Call Farendcontrol Camera Stop

    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. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 120: Xcommand Call Hold

    Call Join CallId: CallId where CallId: Integer (0..65534) You can have from 1 to 10 CallId parameters in the same command. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 121: Xcommand Call Unattendedtransfer

    CallHistory DeleteAll [Filter: Filter] where Filter: All/Missed/Placed/Received You can filter which calls to delete. The default is set to All. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 122: Xcommand Callhistory Deleteentry

    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. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 123: Xcommand Callhistory Recents

    CallHistoryId for the call in question. Order: OccurrenceTime/OccurrenceFrequency Define the order in which the previous calls are presented. The default is set to OccurenceTime. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 124: Xcommand Camera Positionset

    The ID of the camera preset you want to activate. If CameraId is not specified, all cameras will be set in their respective default position, if one is defined. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 125: Xcommand Camera Preset Edit

    Camera Preset Remove PresetId: PresetId where PresetId: Integer (1..35) The ID of the camera preset you want to remove. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 126: Xcommand Camera Preset Show

    Note that each camera can hold only one default position, so if set, the old default preset will automatically be marked as not default. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 127: Xcommand Camera Ramp

    Zoom the camera In or Out, followed by Stop. ZoomSpeed: Integer (1..15) Set the zoom speed. Focus: Far/Near/Stop Focus the camera Far or Near, followed by Stop. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 128: Cameras Commands

    Requires user role: ADMIN, INTEGRATOR, USER USAGE: xCommand Cameras PresenterTrack ClearPosition D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 129: Xcommand Cameras Presentertrack Set

    Persistent: This setting is used by the codec's internal scripts. Turns on presenter track- ing in persistent mode. Persitent mode is automatically turned off when camera moves D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 130: Xcommand Cameras Speakertrack Diagnostics Start

    Distance: Integer (300..1500) Set distance to whiteboard in centimeters. Use an accurate measurement for the feature to work seamlessly. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 131: Xcommand Cameras Speakertrack Whiteboard Setdistance

    You can give the position an id number. Currently the only id that can be used is 1. The default is set to 1. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 132: Xcommand Conference Speakerlock Set

    Identify CallID for the remote participant. Only relevant if Target is set to "remote". The all results. The default is set to Alerts. default is set to 0. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 133: Gpio Commands

    Appearance: Integer (1..999999999) Internal usage only. DisplayName: String (0, 255) The display name of the remote participant. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 134: Httpfeedback Commands

    The XPath expression specifies which parts of the Status, Configuration or Event XML documents are monitored. You can have from 0 to 15 XPath expressions in the same command. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 135: Macros Commands

    Specifies the name of the macro to activate. where Name: String (0..255) The name of the macro that is removed. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 136: Xcommand Macros Macro Rename

    Shows the current status of the macros runtime on this device. Requires user role: ADMIN USAGE: xCommand Macros Runtime Status D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 137: Xcommand Macros Runtime Stop

    Requires user role: ADMIN, INTEGRATOR USAGE: xCommand Message Send Text: "Text" where Text: String (0..255) The text that the message contains. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 138: Peripherals Commands

    SoftwareInfo: String (0, 100) Software version the device is running. Type: Byod/ControlSystem/Other/TouchPanel Define the type of device you are connecting to. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 139: Xcommand Peripherals Pairing Devicediscovery Start

    MacAddress: String (1, 1450) Enter the MAC address for the ISDN Link you wish to pair to the endpoint. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 140: Phonebook Commands

    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 type. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 141: Xcommand Phonebook Contact Modify

    Number, Protocol, CallRate, CallType and Device. You can add several contact methods to a contact. Note that only the first contact method will appear in the Favorites list on the Cisco TelePresence Touch controller. The first contact Requires user role: ADMIN, USER method may have been created when issuing the xCommand Phonebook Contact Add command to make the contact.
  • Page 142: Xcommand Phonebook Contactmethod Delete

    Set a call rate. The default is set to 0. CallType: Audio/Video Select a call type (audio or video). D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 143: Xcommand Phonebook Folder Add

    Phonebook Search command. It was also returned when the xCommand Phonebook Folder Add command was issued to make the folder. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 144: Xcommand Phonebook Search

    Search only in the specified folder. The FolderId (string) is listed in the ResultSet of a search result containing folders. Limit: Integer (0..65534) D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 145: Presentation Commands

    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. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 146: Xcommand Provisioning Extensionmobility Login

    This command will log you out of your Extension Mobility profile. Requires user role: ADMIN, USER USAGE: xCommand Provisioning ExtensionMobility Logout D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 147: Roompreset Commands

    USAGE: xCommand RoomPreset Clear PresetId: PresetId where PresetId: Integer (1..15) The ID of the preset you want to delete. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 148: Xcommand Security Certificates Ca Show

    Format: Literal (PEM / Text ) Specifies the format of the results. The default is set to Text. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 149: Xcommand Security Certificates Services Deactivate

    The unique Identifier for the certificate that is deleted. You can get the fingerprint ID by running xCommand Security Certificates Services Show. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 150: Xcommand Security Persistency

    Reboots the system. xCommand Security Session List List active sessions. Requires user role: ADMIN, USER USAGE: xCommand Security Session List D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 151: Standby Commands

    Requires user role: ADMIN, INTEGRATOR USAGE: xCommand Standby Halfwake D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 152: Systemunit Commands

    NetworkServices Wifi Allowed xConfiguration NetworkServices Wifi Enabled Spark: xConfiguration Spark ServiceOverrides GdsBaseUrl xConfiguration Spark ServiceOverrides U2CBaseUrl xConfiguration Spark ServiceOverrides WdmBaseUrl D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 153: Xcommand Systemunit Firsttimewizard Stop

    Clears the list of system notifications that are reported by xStatus SystemUnit Notifications Text/Type. where Type: Encryption/MultiSite/RemoteMonitoring Requires user role: ADMIN USAGE: xCommand SystemUnit Notifications RemoveAll D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 154: Xcommand Systemunit Optionkey Removeall

    Get the custom message set with xCommand SystemUnit SignInBanner Set. Confirm: Yes Requires user role: ADMIN USAGE: xCommand SystemUnit SignInBanner Get D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 155: Xcommand Systemunit Softwareupgrade

    The default value is True. Month: Integer (1..12) Day: Integer (1..31) Hour: Integer (0..23) Minute: Integer (0..59) Second: Integer (0..59) D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 156: Userinterface Commands

    Delete all user interface extensions (widgets) from the video system. Specifies which image to show. Requires user role: ADMIN USAGE: xCommand UserInterface Extensions Clear D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 157: Xcommand Userinterface Extensions List

    The value of the widget. The range of values depends on the widget type. USAGE: xCommand UserInterface Message Alert Clear WidgetId: String (0..40) The unique identifier for the widget. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 158: Xcommand Userinterface Message Alert Display

    Enter the text to appear on the feedback options. The FeedbackId corresponds to the FeedbackId given by the xCommand Message Prompt Display command. Option.3: String (0, 255) D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 159: Xcommand Userinterface Message Prompt Response

    UserInterface Message TextInput Display Enter the text to appear on the feedback options. Displays an input dialog box to which a user can respond, on the Cisco Telepresence Touch 10 Option.4: String (0, 255) and on the main screen of the Cisco DX80.
  • Page 160: Xcommand Userinterface Message Textline Clear

    Message TextLine Clear command has been sent. The default is set to 0. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 161: Xcommand Userinterface Presentation Externalsource Remove

    The unique string that identifies this input source. It was defined when the source was created with the UserInterface Presentation ExternalSource Add command. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 162: Usermanagement Commands

    Requires user role: ADMIN USAGE: xCommand UserManagement RemoteSupportUser DisablePermanently Confirm: Confirm where Confirm: Yes D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 163: Xcommand Usermanagement User Add

    Specify a username to show the details of a particular user. Username: String (0..127) Specifies the user’s username. YourPassphrase: String (0..255) The user’s passphrase. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 164: Xcommand Usermanagement User List

    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. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 165: Xcommand Usermanagement User Passphrase Change

    UserManagement User Passphrase Set NewPassphrase: "NewPassphrase" Username: "Username" YourPassphrase: "YourPassphrase" where NewPassphrase: String (0, 255) Username: String (0, 127) YourPassphrase: String (0, 255) D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 166: Xcommand Video Input Setmainvideosource

    Call command to see the CallId. LayoutFamily: auto/custom/equal/overlay/prominent/single Select a layout family. CustomLayoutName: String (1, 128) Enter a name for the layout. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 167: Xcommand Video Matrix Assign

    The identifier (ID) of the input source. Input Source [n] has ID n. Run the following API Choose the output you want to reset. command to find the ID: xStatus Video Input Source. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 168: Xcommand Video Output Monitor Backlight Set

    (dual screen systems). systems). Value: Integer (0..100) Value: Integer (0..100) Select the level. Select the level. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 169: Xcommand Video Output Monitor Color Red Set

    (dual screen systems). systems). Value: 4900K/5500K/6500K/7200K/9300K/10500K/12000K/User Value: RGB/YUV Select either RGB or YUV. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 170: Xcommand Video Output Monitor Gamma Set

    Select one of the predefined positions. parameter is only present for video systems with two integrated screens (dual screen systems). D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 171: Xcommand Video Presentationview Set

    Choose between displaying the self-view in full screen or as picture-in-picture. PIPPosition: CenterLeft/CenterRight/LowerLeft/LowerRight/UpperCenter/UpperLeft/UpperRight Select the position for the self-view image. OnMonitorRole: First/Fourth/Second/Third Displays self-view on monitors with this role. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 172: Xstatus Commands

    Cisco TelePresence MX700 and MX800 API Reference Guide  Introduction About the API xConfiguration xCommand xStatus xStatus Appendices Chapter 5 xStatus commands D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 173: Description Of The Xstatus Commands

    Bookings status ..........................182 xStatus Cameras Camera [n] HardwareID ....................186 xStatus Bookings Current Id ........................182 xStatus Cameras Camera [n] MacAddress ....................186 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 174 HttpFeedback [1..4] URL ......................199 xStatus Conference Call [n] Capabilities IxChannel Status ..............192 xStatus Conference Call [n] Capabilities Presentation ................192 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 175 Network 1 CDP VoIPApplianceVlanID ..................205 xStatus Provisioning Software UpgradeStatus Phase ................212 xStatus Network 1 CDP VTPMgmtDomain ..................... 205 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 176 SIP Registration [n] Status ......................218 xStatus UserInterface ContactInfo ContactMethod [n] Number ..............224 xStatus SIP Registration [n] URI ........................218 xStatus UserInterface ContactInfo Name ....................224 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 177 Video Output Connector [n] ConnectedDevice CEC PowerControl .......... 229 xStatus Video Selfview PIPPosition ......................234 xStatus Video Output Connector [n] ConnectedDevice CEC PowerStatus ..........229 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 178: Audio Status

    Requires user role: ADMIN, USER Example: xStatus Audio Input LocalInput 1 Connector *s Audio Input LocalInput 1 Connector: "Microphone.1" ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 179: Xstatus Audio Input Localinput [n] Mixermode

    Value space of the result returned: On/Off Example: xStatus Audio Microphones Mute *s Audio Microphones Mute: Off ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 180: Xstatus Audio Output Connectors Line [n] Delayms

    Value space of the result returned: 1..2 Example: xStatus Audio Output LocalOutput 4 Channels *s Audio Output LocalOutput 4 Channels: "1" ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 181: Xstatus Audio Output Localoutput [n] Loudspeaker

    *s Audio Output RemoteOutput 9 CallId: 28 Example: ** end xStatus Audio Output LocalOutput 4 Name *s Audio Output LocalOutput 4 Name: "MyLocalOutput1" ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 182: Xstatus Audio Output Remoteoutput [n] Input [n] Gain

    Requires user role: ADMIN, USER Value space of the result returned: Off/On Example: xStatus Audio VolumeMute *s Audio VolumeMute: Off ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 183: Call Status

    Example: *s Call 27 Direction: Outgoing xStatus Call 27 CallbackNumber ** end *s Call 27 CallbackNumber: "h323:firstname.lastname@company.com" ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 184: Xstatus Call [n] Displayname

    Value space of the result returned: None/Aes-128 Example: xStatus Call 27 Encryption Type *s Call 27 Encryption Type: "None" ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 185: Xstatus Call [n] Placedonhold

    Call 27 ReceiveCallRate xStatus Call 27 TransmitCallRate *s Call 27 ReceiveCallRate: 4000 *s Call 27 TransmitCallRate: 768 ** end ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 186: Cameras Status

    *s Camera 1 MacAddress: "" Integer ** end Example: xStatus Cameras Camera 1 DetectedConnector *s Cameras Camera 1 DetectedConnector: 1 ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 187: Xstatus Cameras Camera [n] Manufacturer

    *s Camera 1 Position Focus: 4597 xStatus Cameras Camera 1 Position Tilt ** end *s Camera 1 Position Tilt: 106 ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 188: Xstatus Cameras Camera [n] Position Zoom

    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 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 189: Xstatus Cameras Presentertrack Status

    Integer ** end Example: xStatus Cameras SpeakerTrack *s Cameras SpeakerTrack Availability: Available *s Cameras SpeakerTrack Status: Active ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 190: Capabilities Status

    Value space of the result returned: 0..5 Example: xStatus Capabilities Conference MaxCalls *s Capabilities Conference MaxCalls: 3 ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 191: Conference Status

    *s Conference Call 2 Capabilities FECC NumberOfSources: 5 xStatus Conference Call Capabilities FarendMessage Mode ** end *s Conference Call 4 Capabilities FarendMessage Mode: Off ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 192: Xstatus Conference Call [n] Capabilities Fecc Source [n] Name

    *s Conference Call 2 Capabilities Presentation: True *s Conference Call 2 Capabilities FECC Source 1 SourceId: 6 ** end ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 193: Xstatus Conference Call [n] Manufacturer

    Value space of the result returned: String Example: xStatus Conference Call 2 SoftwareID *s Conference Call 2 SoftwareID: "CE8" ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 194: Xstatus Conference Multipoint Mode

    *s Conference Presentation CallId: 0 Off/Sending/Receiving ** end Example: xStatus Conference Presentation Mode *s Conference Presentation Mode: Off ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 195: Xstatus Conference Speakerlock Callid

    Value space of the result returned: Error/Warning/Critical Example: xStatus Diagnostics Message 4 Level *s Diagnostics Message 4 Level: Warning ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 196: Xstatus Diagnostics Message [n] References

    FirstTimeWizardNotCompleted / CaptivePortalDetected / MonitorDelay / WifiCARequired / MicrophonesConnected Example: xStatus Diagnostics Message Type *s Diagnostics Message 1 Type: CamerasDetected ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 197: Gpio Status

    Value space of the result returned: String Example: xStatus H323 Gatekeeper Reason *s H323 Gatekeeper Reason: "" ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 198: Xstatus H323 Gatekeeper Status

    Value space of the result returned: String Example: xStatus H323 Mode Reason *s H323 Mode Reason: "" ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 199: Httpfeedback Status

    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 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 200: Xstatus Mediachannels Call [n] Channel [n] Audio Protocol

    MediaChannels Call 27 Channel 327 NetStat Bytes *s MediaChannels Call 27 Channel 327 NetStat Bytes: 496640 ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 201: Xstatus Mediachannels Call [n] Channel [n] Netstat Channelrate

    *s MediaChannels Call 27 Channel 327 NetStat LastIntervalLost: 0 *s MediaChannels Call 27 Channel 327 NetStat MaxJitter: 2 ** end ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 202: Xstatus Mediachannels Call [n] Channel [n] Netstat Packets

    MediaChannels Call 27 Channel 327 Video ChannelRole *s MediaChannels Call 27 Channel 327 Video ChannelRole: Main ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 203: Xstatus Mediachannels Call [n] Channel [n] Video Framerate

    MediaChannels Call 27 Channel 327 Video Protocol *s MediaChannels Call 27 Channel 327 Video Protocol: H264 ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 204: Network Status

    *s Network 1 CDP PortID: "GigabitEthernet1/0/23" Example: ** end xStatus Network CDP DeviceId *s Network 1 CDP DeviceId: "123456.company.com" ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 205: Xstatus Network 1 Cdp Primarymgmtaddress

    *s Network 1 CDP SysObjectID: "" Example: ** end xStatus Network CDP VTPMgmtDomain *s Network 1 CDP VTPMgmtDomain: "anyplace" ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 206: Xstatus Network 1 Dns Domain Name

    Network 1 IPv4 Gateway *s Network 1 Ethernet MacAddress: "00:50:60:02:FD:C7" *s Network 1 IPv4 Gateway: "192.0.2.10" ** end ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 207: Xstatus Network 1 Ipv4 Subnetmask

    Value space of the result returned: String Example: xStatus Network 1 IPv6 Gateway *s Network 1 IPv6 Gateway: "" ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 208: Networkservices Status

    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 D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 209: Peripherals Status

    *s Peripherals ConnectedDevice 1001 Type: TouchPanel xStatus Peripherals ConnectedDevice 1007 Name ** end *s Peripherals ConnectedDevice 1007 Name: "Cisco TelePresence Touch" ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 210: Xstatus Peripherals Connecteddevice [n] Upgradestatus

    Value space of the result returned: String Example: xStatus Provisioning CUCM ExtensionMobility LastLoggedInUserId *s Provisioning CUCM ExtensionMobility LastLoggedInUserId: "User 1" ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 211: Xstatus Provisioning Cucm Extensionmobility Loggedin

    *s Provisioning Software Current URL: "http://.../s52020ce8 _ 0 _ 0.pkg" *s Provisioning Software UpgradeStatus Message: "" ** end ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 212: Xstatus Provisioning Software Upgradestatus Phase

    Value space of the result returned: None/InProgress/Failed/InstallationFailed/Succeeded Example: xStatus Provisioning Software UpgradeStatus Status *s Provisioning Software UpgradeStatus Status: None ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 213: Xstatus Provisioning Status

    Provisioning Status xStatus Proximity Services Availability *s Provisioning Status: Provisioned *s Proximity Services Availability: Disabled ** end ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 214: Roomanalytics Status

    Value space of the result returned: NonPersistent/Persistent Example: xStatus Security Persistency CallHistory *s Security Persistency CallHistory: Persistent ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 215: Xstatus Security Persistency Configurations

    Value space of the result returned: NonPersistent/Persistent Example: xStatus Security Persistency InternalLogging *s Security Persistency InternalLogging: Persistent ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 216: Sip Status

    Value space of the result returned: *s SIP CallForward URI: "" Digest/Off ** end Example: xStatus SIP Authentication *s SIP Authentication: Off ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 217: Xstatus Sip Mailbox Messageswaiting

    SIP Registration 1 Authentication *s SIP Proxy 1 Address: "192.0.2.50" *s SIP Registration 1 Authentication: Off ** end ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 218: Xstatus Sip Secure

    Value space of the result returned: Deregister/Failed/Inactive/Registered/Registering Example: xStatus SIP Registration 1 Status *s SIP Registration 1 Status: Registered ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 219: Xstatus Sip Verified

    SIP Verified Shows whether or not the SSL certificate of the server that the video system / codec tries to register to is included in the codec’s trusted CA-list. The server is typically a Cisco VCS or xStatus Standby PowerSave State CUCM.
  • Page 220: Systemunit Status

    SystemUnit Hardware Module CompatibilityLevel Requires user role: ADMIN, USER The Cisco TelePresence endpoints are using a NAND flash memory for general storage. The Value space of the result returned: endpoints running TC software are manufactured with a new version of the flash memory.
  • Page 221: Xstatus Systemunit Notifications Notification [n] Type

    *s SystemUnit ProductId: "Cisco TelePresence Codec SX80" xStatus SystemUnit Software DisplayName ** end *s SystemUnit Software DisplayName: "Display Name" ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 222: Xstatus Systemunit Software Name

    SystemUnit Software Version *s SystemUnit Software OptionKeys MultiSite: "true" *s SystemUnit Software Version: "CE8.0.0" ** end ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 223: Xstatus Systemunit State Numberofactivecalls

    Value space of the result returned: 0..5 Example: xStatus SystemUnit State NumberOfSuspendedCalls *s SystemUnit State NumberOfSuspendedCalls: 0 ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 224: Time Status

    The value is an empty string until a value is set with the UserInterface Extensions Widget SetValue command. Requires user role: ADMIN, INTEGRATOR, USER, ROOMCONTROL Value space of the result returned: String D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 225: Xstatus Userinterface Extensions Widget [n] Widgetid

    Value space of the result returned: False/True/Unknown Example: xStatus Video Input Connector 1 Connected *s Video Input Connector 1 Connected: True ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 226: Xstatus Video Input Connector [n] Signalstate

    *s Video Input Source 1 Resolution FormatStatus: Ok *s Video Input Connector 1 Type: HDMI ** end ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 227: Xstatus Video Input Source [n] Formattype

    Video Input Source 1 Resolution Height ** end *s Video Input Source 1 Resolution Height: 1080 ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 228: Xstatus Video Layout Layoutfamily Remote

    Video Output Connector 1 ConnectedDevice CEC DeviceType *s Video Monitors: Single *s Video Output Connector 1 ConnectedDevice CEC DeviceType: TV ** end ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 229: Xstatus Video Output Connector [n] Connecteddevice Cec Vendorid

    *s Video Output Connector 1 ConnectedDevice CEC PowerControl: Ok *s Video Output Connector 1 ConnectedDevice Name: "G2420HDBL" ** end ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 230: Xstatus Video Output Connector [n] Connecteddevice Preferredformat

    120..3000 Example: xStatus Video Output Connector 1 Resolution Height *s Video Output Connector 1 Resolution Height: 1080 ** en D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 231: Xstatus Video Output Connector [n] Resolution Refreshrate

    *s Video Output Connector 1 Type: HDMI *s Video Output Monitor 1 ColorTemperature Blue: 50 ** end ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 232: Xstatus Video Output Monitor [n] Colortemperature Green

    *s Video Output Monitor 1 ColorTemperature Selected: 6500 *s Video Output Monitor 1 Gamma: "2.2" ** end ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 233: Xstatus Video Output Monitor [n] Position

    *s Video Selfview OnMonitorRole: First xStatus Video Presentation PIPPosition ** end *s Video PIP Presentation Position: CenterLeft ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 234: Xstatus Video Selfview Pipposition

    Value space of the result returned: UpperLeft/UpperCenter/UpperRight/CenterLeft/CenterRight/LowerLeft/LowerRight Example: xStatus Video Selfview PIPPosition *s Video Selfview PIPPosition: LowerRight ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 235: Appendices

    Cisco TelePresence MX700 and MX800 API Reference Guide  Introduction About the API xConfiguration xCommand xStatus Appendices Appendices Chapter 6 Appendices D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 236: About Startup Scripts

    Use the codec’s web interface to create and manage startup scripts. Read more about the web interface and startup scripts in the Administrator guide for your product. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 237: The Systemtools Commands

    • Number of failed logins until a user is set inactive. Suspend-time after max failed login attempts (minutes) [0]? D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 238 Max consecutive identical characters in passwords [0]? • Maximum consecutive identical characters in passwords. <password>: The password for the sudo user. D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 239: About Disconnect Cause Types

    *e CallDisconnect CauseValue: 1 CauseType: “LocalDisconnect” CauseString: “” OrigCallDirection: “outgoing” RemoteURI: “firstname.lastname@company.com” CallId: 89 CauseCode: 0 CauseOrigin: SIP ** end D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 240: User Documentation On The Cisco Web Site

    • Video conferencing room guidelines: Things to do to improve the perceived audio quality D15335.08 Cisco TelePresence MX700 and MX800 API Reference Guide CE9.2, NOVEMBER 2017. Copyright © 2017 Cisco Systems, Inc. All rights reserved.
  • Page 241 Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/go/trademarks. Third- party trademarks mentioned are the property of their respective owners.

This manual is also suitable for:

Mx800

Comments to this Manuals

Symbols: 0
Latest comments: