Table Of Contents - Cisco TelePresence SX80 Reference Manual

Cisco TelePresence SX80
Contents Contents Contents Introduction
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.
TA - ToC - Hidden
We recommend you visit our web site
text anchor
regularly for updated versions of the user
documentation.
Go to:http://www.cisco.com/go/sx-docs
Codec SX80 API Reference Guide TC7.3, OCTOBER 2015.
D15107.05
About the API xConfiguration

Table of Contents

Introduction ..........................................................................4
About this guide ......................................................................5
User documentation .............................................................5
What's new in this version ......................................................6
Software release notes ........................................................6
New features and improvements .........................................6
System configuration changes ............................................. 7
System command changes..................................................8
System status changes ........................................................9
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
Ethernet port ...................................................................... 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
Feedback mechanism........................................................... 19
Feedback expressions ....................................................... 19
Terminal connections .........................................................20
2
xCommand xStatus
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
Audio configuration ............................................................ 31
Cameras configuration .......................................................36
Conference configuration ..................................................40
FacilityService configuration ..............................................44
GPIO configuration .............................................................45
H323 configuration .............................................................45
Logging configuration ........................................................48
Network configuration ........................................................48
NetworkServices configuration ..........................................55
Peripherals configuration ...................................................59
Phonebook configuration ...................................................60
Provisioning configuration ..................................................60
RTP configuration ...............................................................62
Security configuration ........................................................63
SerialPort configuration ......................................................64
SIP configuration ................................................................65
Standby configuration ........................................................69
SystemUnit configuration ...................................................70
Time configuration .............................................................. 71
UserInterface configuration ................................................73
Video configuration ............................................................ 74
Experimental configuration ................................................82
xCommand commands .......................................................83
Description of the xCommand commands ...........................84
Audio commands ...............................................................88
Bookings commands .......................................................... 97
Boot commands .................................................................99
Call commands ..................................................................99
CallHistory commands ..................................................... 101
Copyright © 2015 Cisco Systems, Inc. All rights reserved.
API Reference Guide
Appendices