Technical References

D14642.13 Codec C40-C60 API Reference Guide TC6.3, NOVEMBER 2013. Copyright © 2010–2013 Cisco Systems, Inc. All rights reserved. 2
Cisco TelePresence System Codec C40/C60 API Reference Guide
TA - ToC - Hidden
text anchor
Table of Contents
Introduction ..........................................................................3
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
xConfiguration ...................................................................... 6
xCommand ........................................................................... 7
xStatus .................................................................................8
About the API
......................................................................10
API fundamentals
.................................................................. 11
Connecting to the API ........................................................ 11
Password ........................................................................... 11
RS-232/serial connection .................................................. 11
Telnet .................................................................................. 11
SSH .................................................................................... 11
HTTP/HTTPS ...................................................................... 11
API output
............................................................................. 12
The output modes .............................................................. 12
Using the command line
....................................................... 13
API commands ...................................................................13
Other commands ...............................................................13
Command line shortcuts .................................................... 13
Searching ...........................................................................14
Value types and formats ....................................................14
Commands
...........................................................................15
Configurations
......................................................................16
Status
.................................................................................... 17
Events
...................................................................................18
Call history
............................................................................19
Feedback mechanism...........................................................20
Feedback expressions
.......................................................20
Terminal connections ......................................................... 21
Using HTTP
...........................................................................22
Getting status and configurations ......................................22
Sending commands and configurations.............................22
Using HTTP POST .............................................................. 22
Feedback from codec over HTTP
........................................23
Registering for feedback
....................................................23
Translating from terminal mode to XML..............................24
Dos and don’ts
......................................................................25
xConfiguration commands
..................................................26
Description of the xConfiguration commands
...................... 27
xCommand commands
....................................................... 85
Description of the xCommand commands
...........................86
xStatus commands
............................................................141
Description of the xStatus commands
............................... 142
Appendices....................................................................... 218
About startup scripts
..........................................................219
Cisco TelePresence Remote Control
..................................220
Remote control key map
..................................................... 221
The SystemTools commands
..............................................222
About disconnect cause types
...........................................224
What’s in this guide?
The top menu bar and the entries in the table
of contents are all hyperlinks, just click on
them to 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/cseries-docs
Contents
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Contents
Contents