D14869.11
Codec C20 API Reference Guide TC7.0, JANUARY 2014.
Copyright © 2010–2014 Cisco Systems, Inc. All rights reserved.
2
Cisco TelePresence System Codec C20
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
System configuration changes .............................................6
System command changes ..................................................6
System status changes ........................................................6
About the API ........................................................................7
Connecting to the API ..........................................................8
Password ..............................................................................8
RS-232/serial connection .....................................................8
Telnet ....................................................................................8
SSH ......................................................................................8
HTTP/HTTPS ........................................................................8
API output ...............................................................................9
The output modes ................................................................9
Using the command line ....................................................... 10
API commands ................................................................... 10
Other commands................................................................ 10
Command line shortcuts .................................................... 10
Searching ........................................................................... 11
Value types and formats ..................................................... 11
Commands ............................................................................ 12
Configurations ....................................................................... 13
Status .................................................................................... 14
Events ................................................................................... 15
Call history ............................................................................ 16
Feedback mechanism ........................................................... 17
Feedback expressions ....................................................... 17
Terminal connections ......................................................... 18
Using HTTP ........................................................................... 19
Getting status and configurations ...................................... 19
Sending commands and configurations ............................. 19
Using HTTP POST .............................................................. 19
Feedback from codec over HTTP .........................................20
Registering for feedback ....................................................20
Translating from terminal mode to XML .............................21
Dos and don’ts ......................................................................22
xConfiguration commands ..................................................23
Description of the xConfiguration commands ......................24
xCommand commands ....................................................... 74
Description of the xCommand commands ...........................75
xStatus commands ........................................................... 116
Description of the xStatus commands ................................ 117
Appendices ....................................................................... 188
Startup script ......................................................................189
Adding a startup script .....................................................189
Cisco TelePresence Remote Control ..................................190
Remote control key map ..................................................... 191
The SystemTools commands ..............................................192
About disconnect cause types ...........................................194
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/quickset-docs
Contents
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Contents
Contents
