Cisco TelePresence SX20 Codec User Manual

D14949.13 SX20 Codec API Reference Guide TC7.3, OCTOBER 2015. Copyright © 2015 Cisco Systems, Inc. All rights reserved. 2
Cisco TelePresence SX20 Codec 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
New features and improvements .........................................5
System configuration changes .............................................6
System command changes.................................................. 7
System status changes ........................................................8
About the API ........................................................................9
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
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
xConfiguration commands ..................................................25
Description of the xConfiguration commands ......................26
xCommand commands ....................................................... 83
Description of the xCommand commands ...........................84
xStatus commands ...........................................................128
Description of the xStatus commands ...............................129
Appendices........................................................................211
Startup script ...................................................................... 212
Adding a startup script ..................................................... 212
Cisco TelePresence Remote Control .................................. 213
Remote control key map ..................................................... 214
The SystemTools commands .............................................. 215
About disconnect cause types ........................................... 217
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/sx-docs
Contents
Introduction
About the API
xConfiguration
Appendices
xCommand
xStatus
Contents
Contents

Cisco TelePresence SX20 Codec Specifications

General

Brand	Cisco
Model	TelePresence SX20 Codec
Category	Conference System
Language	English