Table Of Contents - Cisco Codec C20 Reference Manual

Cisco TelePresence System Codec C20
Contents Contents Contents Introduction
What's in this guide?
The top menu bar and the entries in the Table of
TA - ToC - Hidden
Contents are all hyperlinks, just click on them to
text anchor
go to the topic.
We recommend you visit our web site regularly for
updated versions of the user documentation. Go to:
http://www.cisco.com/go/telepresence/docs
Codec C20 API Reference Guide TC6.0 February 2013.
D14869.05
About the API xConfiguration

Table of Contents

Introduction
About this guide .................................................................. 4
User documentation ........................................................ 4
What's new in this version .................................................. 5
Software release notes ................................................... 5
Software download ......................................................... 5
New features and improvements .................................... 5
xCommand changes ....................................................... 7
xStatus changes .............................................................. 8
About the API
API fundamentals .............................................................. 10
Connecting to the API ................................................... 10
Password ....................................................................... 10
RS-232/serial connection .............................................. 10
Telnet ............................................................................. 10
SSH................................................................................ 10
HTTP/HTTPS ................................................................. 10
API output ...........................................................................11
The output modes ..........................................................11
Using the command line ....................................................12
API commands ...............................................................12
Other commands ............................................................12
Command line shortcuts ................................................12
Searching .......................................................................13
Value types and formats .................................................13
Commands .........................................................................14
Configurations ................................................................... 15
Status ................................................................................ 16
Events .................................................................................17
Example 1: Outgoing Call Indication ..............................17
Example 2: Call Disconnect ...........................................17
Example 3: Call Successful ............................................17
Example 4: FECC Action request ...................................17
2
xCommand xStatus
Call history ......................................................................... 18
Feedback mechanism ....................................................... 19
Feedback expressions .................................................. 19
Terminal connections .................................................... 20
Using HTTP ....................................................................... 21
Getting status and configurations ................................. 21
Sending commands and configurations ........................ 21
Using HTTP POST ......................................................... 21
Feedback from codec over HTTP ..................................... 22
Registering for feedback ............................................... 22
Translating from terminal mode to XML ........................ 23
Dos and don'ts .................................................................. 24
Description of the xConfiguration commands
Description of the xConfiguration commands .................. 26
Description of the xCommand commands
Description of the xCommands commands ...................... 69
Description of the xStatus commands
Description of the xStatus commands ............................ 103
Appendices
Startup script ................................................................... 164
Adding a startup script ................................................ 164
Cisco TelePresence Remote Control .............................. 165
Remote control key map ................................................. 166
The SystemTools commands .......................................... 167
About disconnect cause types ....................................... 169
Copyright © 2010-2013 Cisco Systems, Inc. All rights reserved.
API Reference Guide
Appendices