Cisco TelePresence SX20 Codec API Reference Guide Software version TC6.1 April 2013 Application Programmer Interface (API) Reference Guide Cisco TelePresence SX20 Codec D14949.03 SX20 Codec API Reference Guide TC6.1, April 2013. 1 Copyright © 2013 Cisco Systems, Inc. All rights reserved. Cisco TelePresence SX20 Codec API Reference Guide What’s in this guide? Table of Contents Introduction Using HTTP ....................................................................... 20 Getting status and configurations ................................. 20 TA - ToC - Hidden About this guide .................................................................. 4 The top menu bar and the entries in the Table of Sending commands and configurations ........................ 20 text anchor User documentation ........................................................ 4 Contents are all hyperlinks, just click on them to Using HTTP POST ......................................................... 20 go to the topic. About the API Feedback from codec over HTTP ......................................21 Registering for feedback ................................................21 API fundamentals ................................................................ 9 Translating from terminal mode to XML ......................... 22 We recommend you visit our web site regularly for Connecting to the API ..................................................... 9 updated versions of the user documentation. Go to: Password ......................................................................... 9 Dos and don’ts .................................................................. 23 http://www.cisco.com/go/telepresence/docs RS-232/serial connection ............................................... 9 Telnet ............................................................................... 9 Description of the xConfiguration commands SSH ................................................................................. 9 Description of the xConfiguration commands .................. 25 HTTP/HTTPS ................................................................... 9 API output .......................................................................... 10 Description of the xCommand commands The output modes ......................................................... 10 Description of the xCommands commands ..................... 70 Using the command line ....................................................11 API commands ...............................................................11 Description of the xStatus commands Other commands............................................................11 Command line shortcuts ................................................11 Description of the xStatus commands ............................ 105 Searching .......................................................................12 Value types and formats .................................................12 Appendices Commands ........................................................................ 13 Startup script .................................................................. 163 Adding a startup script ................................................ 163 Configurations ................................................................... 14 Cisco TelePresence Remote Control .............................. 164 Status ................................................................................ 15 Remote control key map ................................................. 165 Events................................................................................ 16 Example 1: Outgoing Call Indication ............................. 16 The SystemTools commands .......................................... 166 Example 2: Call Disconnect ......................................... 16 About disconnect cause types ....................................... 168 Example 3: Call Successful ........................................... 16 Example 4: FECC Action request .................................. 16 Call history .........................................................................17 Feedback mechanism ....................................................... 18 Feedback expressions .................................................. 18 Terminal connections ..................................................... 19 D14949.03 SX20 Codec API Reference Guide TC6.1, April 2013. 2 Copyright © 2013 Cisco Systems, Inc. All rights reserved. Cisco TelePresence SX20 Codec API Reference Guide Chapter 1 Introduction D14949.03 SX20 Codec API Reference Guide TC6.1, April 2013. 3 Copyright © 2013 Cisco Systems, Inc. All rights reserved. Cisco TelePresence SX20 Codec API Reference Guide About this guide User documentation This guide introduces you to the Application Programmer Interface The user documentation for the Cisco TelePresence systems, (API) for the TC software in general, and serve as a reference running the TC software, have several guides suitable to vari- guide for the command line commands for the following product: ous user groups. • Cisco TelePresence SX20 Codec • Video conference room primer • Video conference room acoustics guidelines • Installation guides for the TelePresence systems • Software release notes for the TC software • Getting started guide for the TelePresence systems • User guide for the TelePresence systems (Touch controller) • User guide for the TelePresence systems (Remote Control) • Quick reference guides for the TelePresence systems • Administrator guides for the TelePresence systems • Camera user guide for the PrecisionHD cameras • API reference guide for the SX20 Codec • Regulatory compliance and safety information guides • Legal and license information for the TC software To download the user documentation go to: http://www.cisco.com/go/quickset-docs D14949.03 SX20 Codec API Reference Guide TC6.1, April 2013. 4 Copyright © 2013 Cisco Systems, Inc. All rights reserved. Cisco TelePresence SX20 Codec API Reference Guide What’s new in this version New features and improvements This section provides an overview of the new and changed advanced settings and new features in the TC6.1 software Changes in release key policy and software upgrade Voice mail support and message waiting indication version. management Endpoints registered to a Cisco Unified Communications As from software version TC6.1, you do not need to install Manager (CUCM) can be assigned a voice mail profile. When new release keys; it is sufficient that the video system has a receiving a Busy or No Answer signal from such an endpoint, Software release notes valid release key for an earlier TC software version. the call is forwarded to voice mail. For a complete overview of new features and changes, we As from TC6.1 software will be available for download only If you have a Touch controller, you can access the voice recommend reading the Software Release Notes (TC6). Go at ► http://www.cisco.com, and only for users with a valid mail by tapping the Messages icon. Also a message waiting to: service contract assigned to a CCO (Cisco online connection) notification will appear. ► http://www.cisco.com/en/US/products/ps11424/tsd_ ID. products_support_series_home.html Shared lines support in CUCM Software download Password always prompted on Telnet and SSH When registered to a Cisco Unified Communications Manager For software download go to: When signing into the video system using Telnet or SSH, the (CUCM) the endpoint may be part of a shared line. This ► http://www.cisco.com/cisco/software/navigator.html password will always be prompted. This applies even when means that several devices in the same partition share the the password is empty (not set). same directory number. The different devices sharing the same number receive status from the other appearances on the line. Support for <p> and <br> tags in messages on screen For example, you can set up a shared line so that many For security reasons only <p> and <br> HTML tags are devices share the same number and the first available supported in messages on screen (cf. Message Alert and operator picks up the call (help desk). Assisted call handling, Message Prompt commands). These tags will result in line where an administrator manages the calls for an executive breaks as normal. No other tags will be interpreted; they will (forward, barge in) is another example. Also multiple devices appear as text on the screen. belonging to one person can share the same line, thus allowing him/her to pick up a call on one device and resume it on another (single number reach). Diagnostics logging You can find information about how to set up shared You can use the Touch controller to enable diagnostics lines in the CUCM user documentation (Cisco Unified logging of the video system. Diagnostics logging is meant for Communications Manager System Guide). troubleshooting only, and may lower the system performance while switched on. Ad-hoc conferencing in CUCM Endpoints registered on Cisco Unified Communications G.729 audio codec support in SIP calls Manager (CUCM) version 8.6.2 or later can invoke an ad-hoc Support for the G.729AB audio codec is added in SIP calls in conference. This requires that a conference bridge is added order to provide better IP phone interoperability. G.729 is not as an MCU on CUCM. Any endpoint can participate in the supported in H.323 calls. conference, regardless of where they are registered. If the number of participants drops to two, the conference will de-escalate to a point