Download Print this page

Advertisement

Cisco TelePresence MX700 and MX800
API Reference Guide
Introduction
About the API
xConfiguration
xCommand
xStatus
Appendices
Collaboration Endpoint Software 8.0
FEBRUARY 2016
Application Programmer Interface (API)
Reference Guide
Cisco TelePresence MX700 and MX800
Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016.
1
Copyright © 2016 Cisco Systems, Inc. All rights reserved.
D15335.02

Advertisement

Chapters

   Summary of Contents for Cisco TelePresence MX700

  • Page 1

    Appendices Collaboration Endpoint Software 8.0 FEBRUARY 2016 Application Programmer Interface (API) Reference Guide Cisco TelePresence MX700 and MX800 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 2: Table Of Contents

    Commands ................15 Configurations ..............16 Status ..................17 Events ...................18 Feedback mechanism............19 Feedback expressions ............19 Terminal connections ............20 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 3: Introduction

    Cisco TelePresence MX700 and MX800 API Reference Guide  Introduction Introduction About the API xConfiguration xCommand xStatus Appendices Chapter 1 Introduction Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 4: User Documentation

    • Cisco TelePresence MX700 and MX800 web site are included in theUser documentation on the Cisco web site appendix. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 5: Software Release Notes

    • When receiving an incoming call and until the call is disconnected. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 6

    • Custom video layouts and video composition using TC Console is not supported. • MediaNet is no longer supported. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 7

    Conference [1] Presentation * SIP Profile [1] Outbound Conference [1] VideoBandwidth * SIP Profile [1] Proxy [n] Discovery Experimental * Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 8

    Preset8 / Preset9 / Preset10 / Preset11 / Preset12 / Preset13 / Preset14 / Preset15 / RestoreCameraPosition / DefaultCameraPosition> Video OSD LanguageSelection NEW: <None / RestoreCameraPosition / DefaultCameraPosition> Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 9

    Renamed to: H323 Encryption KeySize Conference [1] AutoAnswer Mode Renamed to: Conference AutoAnswer Mode H323 Profile [1] Gatekeeper Address Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 10

    SIP Turn UserName SIP Profile [1] URI Renamed to: SIP URI SystemUnit ContactInfo Type Renamed to: UserInterface ContactInfo Type Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 11

    Video Layout RemoveAll Experimental * Video Layout Reset FacilityService Dial Video Layout SetPresentationView FarEndControl Preset Store Video Layout UnAssign Key * Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 12

    Required user role: ADMIN OLD: Required user role: ADMIN NEW: Required user role: USER NEW: Required user role: USER Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 13

    Renamed to: RoomPreset * SystemUnit DateTime Get Renamed to: Time DateTime Get SystemUnit DateTime Set Renamed to: Time DateTime Set Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 14

    Cameras Camera [n] UpgradeStatus (was Camera [n] UpgradeStatus) Provisioning NextRetry Cameras SpeakerTrack Whiteboard [n] * Provisioning Reason Conference Call [n] Appearance (was Conference Site [n] Appearance) Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 15

    <path> * means that all configurations starting with xStatus <path> are removed. OLD: <Auto/CUCMMediaResourceGroupList/MultiSite/MultiWay/Off> Camera [n] * NEW: <Auto/CUCMMediaResourceGroupList/MultiSite/Off> Renamed to: Cameras Camera [n] * Diagnostics Message [n] Type Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 16

    Renamed to: UserInterface ContactInfo Name SystemUnit Diagnostics Message [n] * Renamed to: Diagnostics Message [n] * SystemUnit Software MaxAudioCalls Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 17: About The Api

    API Reference Guide  Introduction About the API About the API xConfiguration xCommand xStatus Appendices Chapter 2 About the API Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 18: Api Fundamentals

    Click your user name in the upper right corner and choose Change password in the drop down menu. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 19: Telnet

    POST and GET methods are used to execute commands and get feedback from the codec. This is described in ”Using HTTP” on page 28 in this document. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 20: Api Output

    To set ouput mode to XML, issue the command: </AssignCall> xPreferences outputmode xml </Layout> </Video> </Command> To revert to terminal mode, issue the command: xPreferences outputmode terminal Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 21: Using The Command Line

    Refer to ”Feedback mechanism” on page Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 22: Command Line Shortcuts

    XCOMMAND DIAL NUMBER: foo@bar.org *s Video Output Connector 3 Resolution Width: 1280 xcommand dial number: foo@bar.org ** end xCommand Dial Number: foo@bar.org Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 23: Commands

    ‘:’. xConfiguration H323 Profile 1 H323Alias ID Result: *c xConfiguration H323 Profile 1 H323Alias ID: “changed@company.com” **end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 24: Events

    *e CallSuccessful CallId: 132 Protocol: “h223” Direction: “outgoing” CallRate: 768 RemoteURI: “h223:integratorHQ@company.com” EncryptionIn: “Off” EncryptionOut: “Off” ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 25: 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 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 26: Terminal Connections

    Write in: ** end Result: D: List the new feedback expressions. xFeedback list Write in: /Configuration/Video/MainVideoSource Result: ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 27: Using Http

    <SystemUnit> Response <Name>newName</Name> HTTP/1.1 200 OK </SystemUnit> Content-Type: text/xml </Configuration> Content-Length: 91 <?xml version=”1.0”?> <Command> <CameraPositionSetResult item=”1” status=”OK”/> </Command> Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 28: Feedback From Codec Over Http

    Expression: <S: 1, 255> </HttpFeedback> Expression: <S: 1, 255> </Command> Expression: <S: 1, 255> Expression: <S: 1, 255> Expression: <S: 1, 255> Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 29: Translating From Terminal Mode To Xml

    Video Layout AssignCall CallId: 2 LayoutId: 1 <Command> <Video> <Layout> <AssignCall command=”True”> <CallId>2</CallId> <LayoutId>1</LayoutId> </AssignCall> </Layout> </Video> </Command> Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 30: 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. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 31: Xconfiguration Commands

    Cisco TelePresence MX700 and MX800 API Reference Guide  Introduction About the API xConfiguration xConfiguration xCommand xStatus Appendices Chapter 3 xConfiguration commands Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 32

    Audio Input Microphone [1..8] Mode .................. 41 xConfiguration Cameras SpeakerTrack ConnectorDetection Mode ............47 xConfiguration Audio Input Microphone [1..8] Type ................... 41 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 33

    H323 NAT Address ......................54 xConfiguration Network [1] VLAN Voice Mode ..................63 xConfiguration Network [1] VLAN Voice VlanId ..................63 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 34

    Provisioning ExternalManager Protocol ................70 xConfiguration SystemUnit Name ......................78 xConfiguration Provisioning ExternalManager Path ................... 71 xConfiguration Provisioning ExternalManager Domain ................71 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 35

    Video Selfview Default PIPPosition ..................87 xConfiguration Video Selfview OnCall Mode .................... 88 xConfiguration Video Selfview OnCall Duration ..................88 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 36: Audio Configuration

    Select a value between -24 and 0, in steps of 1 dB. xConfiguration Audio SoundsAndAlerts RingTone: RingTone where RingTone : Sunrise/Mischief/Ripples/Reflections/Vibes/Delight/Evolve/Playful/Ascent/ Calculation/Mellow/Ringer Select a ringtone from the list. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 37: Xconfiguration Audio Input Hdmi [n] Mode

    (locally and to far end) when the associated video source is presented. The audio will be muted when the video source is not presented. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 38: Xconfiguration Audio Input Line [1

    The audio source can be associated with a video source on the video input connector. Define the level of the audio source on the line input connector. See the Audio Level table in the Physical Interface Guide for Cisco TelePresence SX80 for a Requires user role: ADMIN complete overview of the values represented in dB.

  • Page 39: Xconfiguration Audio Input Microphone [1

    Off: Turn off the Noise Reduction. On: The Noise Reduction should be enabled in the presence of low frequency noise. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 40: Xconfiguration Audio Input Microphone [1

    The microphone can be associated with a video source on the video input connector, and See the Audio Level table in the Physical Interface Guide for Cisco TelePresence SX80 for a you can determine whether to play or mute audio depending on whether the video source is complete overview of the values represented in dB.

  • Page 41: Xconfiguration Audio Output Hdmi [2] Level

    On: Enable the audio channel on the HDMI output. Line: Select Line when you have a standard balanced line input. The phantom voltage and pre-amplification is Off. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 42: Xconfiguration Audio Output Line [1

    Define the audio level on the line output connector. See the Audio Level table in the Physical Interface Guide for Cisco TelePresence SX80 for a Select the equalizer ID for the audio source that is connected to the output line.

  • Page 43: Xconfiguration Audio Output Line [1

    Typical situations where the codec does not receive EDID information are: when you connect a Cisco TelePresence 60 camera using 3G-SDI; when you connect a Cisco TelePresence 60 (Cisco PrecisionHD 1080p4xS2) camera; when you use an HDMI repeater that does not pass on EDID information.

  • Page 44: Xconfiguration Cameras Camera [1

    Cameras Camera [n] Brightness DefaultLevel setting. the camera. Manual: Turn the autofocus off and adjust the camera focus manually. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 45: 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. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 46: Xconfiguration Cameras Camera [1..7] Whitebalance Level

    Auto: Normal tracking mode. Conservative: The camera view will change to a new speaker later than in Normal mode. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 47: Xconfiguration Cameras Speakertrack Connectordetection Mode

    Not applicable in this version. On: The Snap to Whiteboard feature is enabled. USAGE: xConfiguration Cameras SpeakerTrack ConnectorDetection CameraRight: CameraRight where Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 48: Conference Configuration

    Conference AutoAnswer Mute: Mute Sip: All calls are set up as SIP calls. where H320: All calls are set up as H.320 calls (only applicable if connected to Cisco Mute : Off/On TelePresence ISDN Link). Off: The incoming call will not be muted.

  • Page 49: Xconfiguration Conference Defaultcall Rate

    (pan, tilt, zoom). You will still be able to control your camera and select your video sources as normal. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 50: Xconfiguration Conference Maxreceivecallrate

    Default value: 10000 USAGE: xConfiguration Conference MaxTotalTransmitCallRate: MaxTotalTransmitCallRate where MaxTotalTransmitCallRate : Integer (64..10000) Set the maximum transmit call rate (kbps). Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 51: Xconfiguration Conference Multistream Mode

    Conference MultiStream Mode The video system supports multistream video for conferences, provided that the conference infrastructure supports the feature (Cisco TelePresence Server 4.2 or later). This means that xConfiguration GPIO Pin [1..4] Mode the video system can compose the video streams locally into a conference layout which utilizes all available screens.

  • Page 52: H323 Configuration

    H323 Gatekeeper Address must also be configured. xConfiguration H323 Authentication LoginName: "LoginName" where LoginName : String (0, 50) The authentication login name. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 53: 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. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 54: 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. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 55: Network Configuration

    On: When set to On, the server-side X.509 certificate will be validated against the local CA-list for all TLS connections. Only servers with a valid certificate will be allowed. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 56: Xconfiguration Network [1] Ieee8021x Useclientcertificate

    : Index that identifies the network. Range: 1..1 TThe 802.1X Anonymous ID string. Identity : String (0, 64) The user name for 802.1X authentication. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 57: Xconfiguration Network [1] Ieee8021x Eap Md5

    Developed by Funk Software and Certicom. Usually supported Define the Peap (Protected Extensible Authentication Protocol) mode. Authenticates LAN by Agere Systems, Proxim and Avaya. clients without the need for client certificates. Developed by Microsoft, Cisco and RSA Security. Requires user role: ADMIN Requires user role: ADMIN...

  • Page 58: Xconfiguration Network [1] Ipstack

    Network IPv4 Gateway and Network IPv4 SubnetMask settings (static addresses). DHCP: The system addresses are automatically assigned by the DHCP server. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 59: Xconfiguration Network [1] Ipv4 Subnetmask

    DHCPv6 server. The Network IPv6 DHCPOptions setting determines which method to use. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 60: Xconfiguration Network [1] Ipv6 Dhcpoptions

    Set the priority of the audio packets in the IP network - the higher the number, the higher the priority. The default value is 0 (best effort). Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 61: Xconfiguration Network [1] Qos Diffserv Video

    The default value is 0 (best effort). higher the priority. The default value is 0 (best effort). Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 62: 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. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 63: 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 64: Xconfiguration Networkservices Http Mode

    Off: The system will not use an NTP server. The NetworkServices NTP Server [n] Address setting will be ignored. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 65: Xconfiguration Networkservices Snmp Mode

    These variables can then "public". If you have the Cisco TelePresence Management Suite (TMS) you must make sure the be queried (set to ReadOnly) and sometimes set (set to ReadWrite) by managing applications.

  • Page 66: Xconfiguration Networkservices Snmp Systemlocation

    Off: The welcome text is: Login successful On: The welcome text is: Welcome to <system name>; Software version; Software release date; Login successful. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 67: Peripherals Configuration

    Requires user role: ADMIN touch panels does not match this setting, the diagnostics service will report it as an inconsis- tency. Note that only one Cisco Touch controller is supported in this version. Default value: "" Requires user role: ADMIN...

  • Page 68: Xconfiguration Phonebook Server [1] Url

    If the NAPTR responses have the "e" flag, external configurations will be requested. Otherwise internal configurations will be requested. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 69: Xconfiguration Provisioning Mode

    TMS: Push configurations to the video system from TMS (Cisco TelePresence Management System). Requires user role: ADMIN Default value: "" VCS: Push configurations to the video system from VCS (Cisco TelePresence Video Communication Server). USAGE: CUCM: Push configurations to the video system from CUCM (Cisco Unified xConfiguration Provisioning Password: "Password"...

  • Page 70: Xconfiguration Provisioning Httpmethod

    Provisioning ExternalManager AlternateAddress Select the HTTP method to be used for the provisioning. Only applicable when the endpoint is provisioned by Cisco Unified Communication Manager (CUCM) and an alternate CUCM is available for redundancy. Define the address of the alternate Requires user role: ADMIN CUCM.

  • Page 71: Proximity Configuration

    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 72: Xconfiguration Proximity Services Contentshare Fromclients

    Set a baud rate from the baud rates listed (bps). Disabled: Content sharing to a Proximity client is disabled. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 73: Xconfiguration Serialport Loginrequired

    Requires user role: ADMIN Default value: "" USAGE: xConfiguration SIP Authentication Password: "Password" where Password : String (0, 128) A valid password. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 74: Xconfiguration Sip Defaulttransport

    Relay: The endpoint will receive media on the IP address and port allocated on the TURN server, and is used as a fallback until ICE has concluded. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 75: Xconfiguration Sip Listenport

    Requires user role: ADMIN Default value: "" USAGE: xConfiguration SIP Turn Password: "Password" where Password : String (0, 128) A valid password. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 76: Xconfiguration Sip Uri

    Requires user role: ADMIN Default value: 10 USAGE: xConfiguration Standby Delay: Delay where Delay : Integer (1..480) Set the standby delay (minutes). Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 77: Xconfiguration Standby Bootaction

    None: No action. PrivacyPosition: When the video system enters standby, the camera turns to a sideways position for privacy. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 78: 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 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 79: Xconfiguration Time Zone

    Australia/Victoria, Australia/West, Australia/Yancowinna, Brazil/Acre, Brazil/DeNoronha, Jujuy, America/Juneau, America/Kentucky/Louisville, America/Kentucky/Monticello, America/ Brazil/East, Brazil/West, CET, CST6CDT, Canada/Atlantic, Canada/Central, Canada/ Knox_IN, America/Kralendijk, America/La_Paz, America/Lima, America/Los_Angeles, Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 80: Userinterface Configuration

    DisplayName: Show the system's display name (refer to the SIP DisplayName setting). Select a time zone from the list. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 81: Xconfiguration Userinterface Keytones Mode

    Default value: English USAGE: xConfiguration UserInterface Language: Language where Language : English/ChineseSimplified/ChineseTraditional/Catalan/Czech/Danish/ Dutch/Finnish/French/German/Hungarian/Italian/Japanese/Korean/Norwegian/Polish/ PortugueseBrazilian/Russian/Spanish/Swedish/Turkish/Arabic/Hebrew Select a language from the list. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 82: Video Configuration

    Use this when a whiteboard camera is connected to the video input. other: Use this when the other options do not match. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 83: Xconfiguration Video Input Connector [1..5] Name

    Sharpness: Gives the highest possible resolution. Used when you want the highest quality of detailed images and graphics. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 84: Xconfiguration Video Input Connector [1

    First and Second. If a presentation is part of the layout, the presentation is shown on the monitor with monitor role Third. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 85: Xconfiguration Video Output Connector [2] Cec Mode

    On: Enable CEC control show the presentation. Monitors/outputs with this monitor role are disregarded by the Video Monitors setting. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 86: Xconfiguration Video Output Connector [n] Resolution

    On: The self-view picture will be shown in fullscreen. DefaultSource : 1/2/3/4 The video input source to use as default presentation source. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 87: 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. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 88: 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. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 89: Xcommand Commands

    Cisco TelePresence MX700 and MX800 API Reference Guide  Introduction About the API xConfiguration xCommand xCommand xStatus Appendices Chapter 4 xCommand commands Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 90

    Call FarEndControl Source Select ..................96 xCommand Camera Ramp ........................103 xCommand Call Hold ..........................96 xCommand Camera TriggerAutofocus .....................103 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 91

    RoomPreset Clear ......................... 118 xCommand Peripherals Pairing DeviceDiscovery Start ................110 xCommand RoomPreset Store ........................ 118 xCommand Peripherals Pairing Pair ......................110 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 92

    UserManagement RemoteSupportUser Create ..............124 xCommand UserManagement RemoteSupportUser Delete ..............124 xCommand UserManagement RemoteSupportUser DisablePermanently ..........124 xCommand UserManagement RemoteSupportUser GetState ..............125 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 93: Audio Commands

    Requires user role: USER USAGE: xCommand Audio SoundsAndAlerts Ringtone Play RingTone: "RingTone" where RingTone: String (1, 100) The name of the ringtone. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 94: Xcommand Audio Volume Set

    Limit: Integer (1..65534) Max number of bookings to list. Offset: Integer (0..65534) Offset number of bookings for this search. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 95: Call Commands

    Value: Left/Right/Up/Down/ZoomIn/ZoomOut DTMFString: String (0, 32) Select the action for how to move the camera. Enter the DTMF string. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 96: Xcommand Call Farendcontrol Camera Stop

    Call command to see the CallId. PresetId: Integer (1..15) The ID of the preset that is stored on the far end codec. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 97: Xcommand Call Ignore

    The CallID is returned when the xCommand Dial command is run. During a call you can run the xStatus Call command to see the CallId. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 98: Callhistory Commands

    Requires user role: USER USAGE: xCommand CallHistory DeleteAll [Filter: Filter] where Filter: All/Missed/Placed/Received You can filter which calls to delete. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 99: Xcommand Callhistory Get

    CallHistoryId for the call in question. CallHistoryId for the call in question. Order: OccurrenceTime/OccurrenceFrequency Define the order in which the previous calls are presented. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 100: Camera Commands

    Camera Preset Activate PresetId: PresetId where PresetId: Integer (1..35) The ID of the camera preset you want to activate. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 101: Xcommand Camera Preset Edit

    Camera Preset Remove PresetId: PresetId where PresetId: Integer (1..35) The ID of the camera preset you want to remove. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 102: 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. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 103: 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. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 104: Cameras Commands

    Auto (default). xCommand Cameras SpeakerTrack Diagnostics Start Tracking: Tracking This setting applies only when using a Cisco TelePresence SpeakerTrack 60 camera. where The SpeakerTrack 60 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...

  • Page 105: Xcommand Cameras Speakertrack Whiteboard Activateposition

    WhiteboardId: Integer (1..8) You can give the position an id number. Currently the only id that can be used is 1. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 106: Conference Commands

    Releases locked speaker set by xCommand Conference SpeakerLock Set. Default voice switching is switched back on. Requires user role: USER USAGE: xCommand Conference SpeakerLock Release Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 107: Diagnostics Commands

    Appearance: Integer (1..999999999) Internal usage only. DisplayName: String (0, 255) The display name of the remote participant. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 108: Gpio Commands

    XPath expressions specify which parts of the Status and Configuration XML documents are monitored. You can have from 1 to 15 XPath expressions. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 109: 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. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 110: Xcommand Peripherals Pairing Unpair

    MacAddress: String (1, 1450) Enter the MAC address for the ISDN Link you wish to pair to the endpoint. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 111: Phonebook Commands

    Set a call rate. CallType: Audio/Video Select a call type (audio or video). Device: Mobile/Other/Telephone/Video Select the device type. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 112: 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: USER method may have been created when issuing the xCommand Phonebook Contact Add command to make the contact.

  • Page 113: Xcommand Phonebook Contactmethod Delete

    Select Auto, SIP, H323 or H320 protocol. CallRate: Integer (0..6000) Set a call rate. CallType: Audio/Video Select a call type (audio or video). Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 114: Xcommand Phonebook Folder Add

    Phonebook Search command. It was also returned when the xCommand Phonebook Folder Add command was issued to make the folder. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 115: Xcommand Phonebook Search

    Limit: Integer (0..65534) Limit the number of records in the result set to this number. For example, if the limit is Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved.

  • Page 116: 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. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 117: Xcommand Provisioning Cucm Ctl Show

    Proximity Services Activate. Requires user role: USER Requires user role: USER USAGE: xCommand Provisioning StartUpgrade USAGE: xCommand Proximity Services Deactivate Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 118: Roompreset Commands

    USAGE: xCommand RoomPreset Clear PresetId: PresetId where PresetId: Integer (1..15) The ID of the preset you want to delete. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 119: Security Commands

    Standby ResetTimer Delay: Delay ConfirmAndReboot: Yes where Reboots the system. Delay: Integer (1..480) Set the delay in minutes. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 120: Systemunit Commands

    Type where where Confirm: Yes Type: Encryption/MultiSite/PremiumResolution/RemoteMonitoring TrailingAction: NoAction/Restart/Shutdown Select Shutdown or NoAction to override the default behaviour (Restart). Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 121: Xcommand Systemunit Optionkey Removeall

    Password: String (0, 255) Hour: Integer (0..23) Password to access the server location, if needed. Minute: Integer (0..59) Second: Integer (0..59) Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 122: Userinterface Commands

    Set how long (in seconds) the message is to be displayed on the screen. If set to 0 (zero) the message does not disappear until a xCommand Message Alert Clear message has been sent. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 123: Xcommand Userinterface Message Prompt Display

    Enter the text to appear on the feedback options. Option.4: String (0, 255) Enter the text to appear on the feedback options. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 124: Xcommand Userinterface Message Textline Display

    Requires user role: ADMIN USAGE: xCommand UserManagement RemoteSupportUser DisablePermanently Confirm: Confirm where Confirm: Yes Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 125: Xcommand Usermanagement User Passphrase Change

    UserManagement User Passphrase Change NewPassphrase: "NewPassphrase" OldPassphrase: "OldPassphrase" YourPassphrase: String (0, 255) where NewPassphrase: String (0, 255) OldPassphrase: String (0, 255) Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 126: Video Commands

    CustomLayoutName: String (1, 128) command to find the ID: xStatus Video Input Source. Enter a name for the layout. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 127: 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. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 128: Xcommand Video Presentationpip 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. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 129: Xstatus Commands

    Cisco TelePresence MX700 and MX800 API Reference Guide  Introduction About the API xConfiguration xCommand xStatus xStatus Appendices Chapter 5 xStatus commands Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 130: Description Of The Xstatus Commands

    Audio Volume ..........................138 xStatus Cameras Camera ........................141 xStatus Audio VolumeMute ........................138 xStatus Cameras Camera [n] Capabilities Options .................. 141 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 131

    Conference Call [n] Capabilities Presentation ................146 xStatus HttpFeedback [1..4] URL ......................151 xStatus Conference Call [n] Manufacturer ....................146 xStatus Conference Call [n] MicrophonesMuted ..................146 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 132

    Security Persistency LocalPhonebook ..................161 Peripherals status ..........................157 xStatus Peripherals ..........................157 xStatus Peripherals ConnectedDevice [n] HardwareInfo .................157 xStatus Peripherals ConnectedDevice [n] ID ...................157 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 133

    Video Input Source [n] MediaChannelId ..................172 xStatus SystemUnit ProductPlatform .......................167 xStatus Video Input Source [n] Resolution Height ..................172 xStatus SystemUnit ProductType ......................167 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 134

    Video Selfview FullscreenMode ....................175 xStatus Video Selfview Mode ........................175 xStatus Video Selfview OnMonitorRole ....................175 xStatus Video Selfview PIPPosition ......................175 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 135: Audio Status

    *s Audio Connectors Microphone 1 EcReferenceDelay: 120 Example: ** end xStatus Audio Input LocalInput 1 Connector *s Audio Input LocalInput 1 Connector: "Microphone.1" ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 136: Xstatus Audio Input Localinput [n] Mixermode

    ** end String Example: xStatus Audio Input LocalInput 1 Name *s Audio Input LocalInput 1 Name: "Microphone" ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 137: Xstatus Audio Output Localoutput [n] Connector [n]

    On/Off ** end Example: xStatus Audio Output LocalOutput 4 Loudspeaker *s Audio Output LocalOutput 4 Loudspeaker: "Off" ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 138: Call Status

    Value space of the result returned: String Example: xStatus Call 27 CallbackNumber *s Call 27 CallbackNumber: "h323:firstname.lastname@company.com" ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 139: Xstatus Call [n] Calltype

    Call [n] DeviceType xStatus Call [n] Duration Indicates whether the remote system is a single endpoint or an MCU. Some Cisco endpoints Shows the duration of a call (in seconds). You can run the command xStatus Call to find the call (SX20, SX80, MX200 G2, MX300 G2) have built-in MCU capabilities.

  • Page 140: Xstatus Call [n] Facilityserviceid

    Example: *s Call 27 RemoteNumber: "5585232" xStatus Call 27 PlacedOnHold ** end *s Call 27 PlacedOnHold: False ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 141: Xstatus Call [n] Status

    Value space of the result returned: Auto/On/Off Example: xStatus Cameras Camera 1 Flip *s Camera 1 Flip: "Off" ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 142: Xstatus Cameras Camera [n] Macaddress

    Value space of the result returned: ** end Off/Unavailable/Available Example: xStatus Cameras SpeakerTrack Availability *s Cameras SpeakerTrack Availability: Unavailable ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 143: Xstatus Cameras Speakertrack Leftcamera Videoinputconnector

    Value space of the result returned: 0..5 Example: xStatus Capabilities Conference MaxCalls *s Capabilities Conference MaxCalls: 3 ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 144: Xstatus Capabilities Conference Maxvideocalls

    Value space of the result returned: On/Off Example: xStatus Conference Call Capabilities FarendMessage Mode *s Conference Call 4 Capabilities FarendMessage Mode: Off ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 145: Xstatus Conference Call [n] Capabilities Fecc Mode

    Conference Call 2 Capabilities FECC NumberOfSources ** end *s Conference Call 2 Capabilities FECC NumberOfSources: 5 ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 146: Xstatus Conference Call [n] Softwareid

    Conference Call 2 SoftwareID *s Conference Call 2 Capabilities Presentation: True *s Conference Call 2 SoftwareID: "CE8" ** end ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 147: Xstatus Conference Donotdisturb

    Value space of the result returned: Integer Example: xStatus Conference Presentation CallId *s Conference Presentation CallId: 0 ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 148: Xstatus Conference Presentation Localinstance [n] Sendingmode

    Value space of the result returned: Off/Sending/Receiving Example: xStatus Conference Presentation Mode *s Conference Presentation Mode: Off ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 149: Diagnostics Status

    *s Diagnostics Message 4 Level: Warning ContactInfoMismatch ** end Example: xStatus Diagnostics Message type *s Diagnostics Message 1 Type: InvalidAdminPassword ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 150: Gpio Status

    Value space of the result returned: String Example: xStatus H323 Gatekeeper Reason *s H323 Gatekeeper Reason: "" ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 151: Xstatus H323 Gatekeeper Status

    Value space of the result returned: Enabled/Disabled Example: xStatus H323 Mode Status *s H323 Mode Status: "Disabled" ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 152: Network Status

    Value space of the result returned: String Example: xStatus Network CDP DeviceId *s Network 1 CDP DeviceId: "123456.company.com" ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 153: Xstatus Network 1 Cdp Primarymgmtaddress

    *s Network 1 CDP SysObjectID: "" Example: ** end xStatus Network CDP VTPMgmtDomain *s Network 1 CDP VTPMgmtDomain: "anyplace" ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 154: 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 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 155: Xstatus Network 1 Ipv4 Subnetmask

    Value space of the result returned: String Example: xStatus Network 1 IPv6 Gateway *s Network 1 IPv6 Gateway: "" ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 156: 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 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 157: Xstatus Peripherals Connecteddevice [n] Name

    Value space of the result returned: String Example: xStatus Peripherals ConnectedDevice 1007 Name *s Peripherals ConnectedDevice 1007 Name: "Cisco TelePresence Touch" ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 158: Xstatus Peripherals Connecteddevice [n] Upgradestatus

    String Example: xStatus Provisioning Software Current VersionId *s Provisioning Software Current VersionId: "s52020ce8 _ 0 _ 0.pkg" ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 159: Xstatus Provisioning Software Upgradestatus Lastchange

    *s Provisioning Software UpgradeStatus URL: "http://.../s52020ce8 _ 0 _ 0.pkg" xStatus Provisioning Software UpgradeStatus Phase ** end *s Provisioning Software UpgradeStatus Phase: None ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 160: Xstatus Provisioning Software Upgradestatus Versionid

    ** end Value space of the result returned: Failed/AuthenticationFailed/Provisioned/Idle/NeedConfig/ConfigError Example: xStatus Provisioning Status *s Provisioning Status: Provisioned ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 161: Security Status

    Value space of the result returned: NonPersistent/Persistent Example: xStatus Security Persistency Configurations *s Security Persistency Configurations: Persistent ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 162: Sip Status

    Off: No authentication mechanism is used. Value space of the result returned: Digest/Off Example: xStatus SIP Authentication *s SIP Authentication: Off ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 163: Xstatus Sip Mailbox Messageswaiting

    *s SIP Proxy 1 Status: Active xStatus SIP Proxy 1 Address ** end *s SIP Proxy 1 Address: "192.0.2.50" ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 164: Xstatus Sip Proxy [n] Verified

    Shows whether or not the SSL certificate of the server that the video system / codec tries to Shows a message to explain the reason why the SIP registration failed. register to is included in the codec’s trusted CA-list. The server is typically a Cisco VCS or Value space of the result returned: CUCM.

  • Page 165: Xstatus Sip Secure

    Shows whether or not the SSL certificate of the server that the video system / codec tries to xStatus Standby State register to is included in the codec’s trusted CA-list. The server is typically a Cisco VCS or CUCM. *s Standby State: Off ** end True: The server’s SIP certificate is checked against the trusted CA-list on the codec and found...

  • Page 166: Systemunit Status

    *s SystemUnit Notifications Notification 1 Type: SoftwareUpgradeOK String ** end Example: xStatus SystemUnit Hardware Temperature *s SystemUnit Hardware Temperature: "64.0" ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 167: Xstatus Systemunit Software Name

    SystemUnit Software OptionKeys MultiSite *s SystemUnit ProductType: "Cisco Codec" *s SystemUnit Software OptionKeys MultiSite: "true" ** end ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 168: Xstatus Systemunit Software Optionkeys Premiumresolution

    Example: *s SystemUnit State NumberOfInProgressCalls: 0 xStatus SystemUnit Software ReleaseDate ** end *s SystemUnit Software ReleaseDate: "2015-05-05" ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 169: Xstatus Systemunit State Numberofsuspendedcalls

    Value space of the result returned: *s Time SystemTime: "2014-04-25T10:04:03Z" Integer ** end Example: xStatus SystemUnit Uptime *s SystemUnit Uptime: 597095 ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 170: Userinterface Status

    *s UserInterface ContactInfo Name: "MySystem" Example: xStatus Video Input Connector 1 Connected ** end *s Video Input Connector 1 Connected: True ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 171: Xstatus Video Input Connector [n] Signalstate

    *s Video Input Source 1 Resolution FormatStatus: Ok Example: ** end xStatus Video Input Connector 1 Type *s Video Input Connector 1 Type: HDMI ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 172: Xstatus Video Input Source [n] Formattype

    Value space of the result returned: ** end Single/Dual/DualPresentationOnly/Triple/Quadruple Example: xStatus Video Monitors *s Video Monitors: Single ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 173: Xstatus Video Output

    String Example: xStatus Video Output Connector 1 ConnectedDevice Name *s Video Output Connector 1 ConnectedDevice Name: "G2420HDBL" ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 174: 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 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 175: Xstatus Video Presentation Pipposition

    Value space of the result returned: On/Off Example: xStatus Video Selfview Mode *s Video Selfview Mode: Off ** end Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 176: Appendices

    Cisco TelePresence MX700 and MX800 API Reference Guide  Introduction About the API xConfiguration xCommand xStatus Appendices Appendices Chapter 6 Appendices Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 177: Startup Scripts

    Use the web interface of the codec to create and manage startup scripts. Read more about the web interface and startup scripts in the Administrator guide for your product. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 178: The Systemtools Commands

    Network debug command. Max failed login attempts [0]? • Number of failed logins until a user is set inactive. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 179

    No argument given: Lists the version of the available • Minimum number of digits in PINs. software images, and shows which one is active. Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 180: 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 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 181: User Documentation On The Cisco Web Site

    • Video conferencing room guidelines: Things to do to improve the perceived audio quality Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016. Copyright © 2016 Cisco Systems, Inc. All rights reserved. D15335.02...

  • Page 182

    IS” WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, On our web site you will find an overview of the worldwide Cisco contacts. WITHOUT LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM Go to: http://www.cisco.com/web/siteassets/contacts...

This manual also for:

Telepresence mx800, Telepresence sx80

Comments to this Manuals

Symbols: 0
Latest comments: