Home
Cisco
Conference System
TelePresence SX20 Codec
Cisco TelePresence SX20 Codec User Manual
5
of 1
of 1 rating
218 pages
Give review
Manual
Specs
To Next Page
To Next Page
Loading...
D
1
4949
.
1
3
SX20 Co
de
c API R
efere
nce G
uid
e TC7
.3, OCTO
BER 201
5.
Co
pyr
igh
t © 20
1
5 Cis
co Sy
ste
ms, In
c. A
ll ri
ghts r
ese
r
ved.
1
Cisco T
eleP
resence S
X20 Codec
API Reference Guide
Sof
t
ware ve
rsi
on TC7
.3
OCTOBER 201
5
Ap
p
l
i
c
a
t
i
o
n P
r
og
r
a
m
me
r I
n
t
e
r
f
a
c
e (
AP
I
)
Re
fer
ence
Gui
de
Cisco T
elePr
esence S
X2
0 Codec
Contents
Introduction
About the API
xConfiguration
Appen
dices
xCommand
xStat
us
2
Table of Contents
What's in this Guide?
2
Table of Contents
2
October
3
About this Guide
4
What's New in this Version
5
System Configuration Changes
6
System Command Changes
7
System Status Changes
8
API Fundamentals
10
API Output
11
Using the Command Line
12
Searching
13
Commands
14
Configurations
15
Status
16
Events
17
Call History
18
Feedback Mechanism
19
Terminal Connections
20
Using HTTP
21
Feedback from Codec over HTTP
22
Translating from Terminal Mode to XML
23
Dos and Don'ts
24
Xconfiguration Commands
25
Description of the Xconfiguration Commands
26
Conference Configuration
36
H323 Configuration
42
Network Configuration
45
Sip Configuration
61
Xcommand Commands
83
Description of the Xcommand Commands
84
Audio Commands
88
Xcommand Call Extendconference
92
Xcommand Call Hold
92
Xcommand Call Holdall
92
Call Commands
92
Xcommand Call Ignore
93
Xcommand Call Join
93
Callhistory Commands
94
Xcommand Callhistory Acknowledgeallmissedcalls
94
Xcommand Callhistory Acknowledgemissedcall
94
Xcommand Callhistory Deleteall
94
Calllog Commands
96
Xcommand Calllog Clear
96
Xcommand Calllog Missed Delete
96
Xcommand Calllog Missed Dismiss
96
Xcommand Calllog Outgoing Delete
96
Xcommand Calllog Received Delete
96
Xcommand Calllog Recent Delete
96
Camctrlpip Commands
97
Xcommand Camctrlpip
97
Camera Commands
97
Xcommand Camera Pantiltreset
97
Xcommand Httpfeedback Deregister
104
Xcommand Httpfeedback Register
104
Key Commands
105
Xcommand Key Click
105
Xcommand Key Press
105
Xcommand Key Release
105
Logging Commands
105
Xcommand Logging Extendedlogging Start
105
Xcommand Logging Extendedlogging Stop
105
Message Commands
106
Xcommand Message Alert Clear
106
Xcommand Message Alert Display
106
Xcommand Message Echo
106
Xcommand Message Farendmessage
106
Xcommand Message Prompt Clear
107
Xcommand Message Prompt Display
107
Xcommand Message Prompt Response
107
Xcommand Message Textline Clear
107
Xcommand Message Textline Display
108
Peripherals Commands
108
Xcommand Peripherals Connect
108
Xcommand Peripherals Heartbeat
108
Xcommand Peripherals List
109
Xcommand Peripherals Manualupgrade
109
Xcommand Peripherals Pairing Devicediscovery Start
109
Xcommand Peripherals Pairing Pair
109
Xcommand Peripherals Pairing Unpair
109
Xcommand Peripherals Pairing Purge
110
Phonebook Commands
110
Xcommand Phonebook Contact Add
110
Xcommand Phonebook Contact Delete
111
Xcommand Phonebook Contact Modify
111
Xcommand Phonebook Contactmethod Add
111
Xcommand Phonebook Contactmethod Delete
112
Xcommand Systemunit Adminpassword Set
119
Xcommand Systemunit Configurationprofile Cancelchange
119
Xcommand Systemunit Configurationprofile Change
119
Xcommand Systemunit Configurationprofile List
119
Xcommand Systemunit Configurationprofile Remove
120
Xcommand Systemunit Configurationprofile Savecurrentconfigurationas
120
Xcommand Systemunit Datetime Get
120
Xcommand Systemunit Datetime Set
120
Xcommand Systemunit Diagnostics Run
120
Xcommand Systemunit Factoryreset
120
Xcommand Systemunit Menupassword Set
121
Xcommand Systemunit Menupassword Validate
121
Xcommand Systemunit Notifications Removeall
121
Xcommand Systemunit Optionkey Add
121
Xcommand Systemunit Optionkey List
121
Xcommand Systemunit Optionkey Remove
121
Xcommand Systemunit Optionkey Removeall
121
Xcommand Systemunit Releasekey Add
121
Xcommand Systemunit Releasekey List
122
Xcommand Systemunit Releasekey Removeall
122
Xcommand Systemunit Softwareupgrade
122
Userinterface Commands
122
Xcommand Userinterface OSD Close
122
Xcommand Userinterface Screenshot Get
122
Xcommand Userinterface Screenshot List
122
Xcommand Userinterface Screenshot Remove
122
Xcommand Userinterface Screenshot Request
123
Xcommand Userinterface Screenshot Store
123
Usermanagement Commands
123
Xcommand Usermanagement Remotesupportuser Create
123
Xcommand Usermanagement Remotesupportuser Delete
123
Xcommand Usermanagement Remotesupportuser Disablepermanently
123
Xcommand Usermanagement Remotesupportuser Getstate
124
Video Commands
124
Xcommand Video OSD Close
125
Xcommand Video Picturelayoutset
126
Xcommand Video PIP Activespeaker Set
126
Xcommand Video PIP Presentation Set
126
Xcommand Video Previewfilmstrip Set
126
Experimental Commands
127
Xstatus Commands
128
Description of the Xstatus Commands
129
Audio Status
137
Call Status
138
Camera Status
141
Xstatus Camera
141
Xstatus Camera [N] Connected
141
Xstatus Camera [N] Hardwareid
141
Xstatus Camera [N] Manufacturer
141
Xstatus Camera [N] Model
142
Xstatus Camera [N] Softwareid
142
Xstatus Camera [N] Serialnumber
142
Xstatus Camera [N] Ipaddress
142
Xstatus Camera [N] Macaddress
142
Xstatus Camera [N] Position Pan
142
Xstatus Camera [N] Position Tilt
142
Xstatus Camera [N] Position Zoom
143
Xstatus Camera [N] Position Focus
143
Xstatus Camera [N] Capabilities Options
143
Xstatus Camera [N] Flip
143
Xstatus Camera [N] Upgradestatus
143
Xstatus Camera [N] Downloadprogress
143
Conference Status
144
Xstatus Conference
144
Xstatus Conference Presentation Mode
144
Xstatus Conference Presentation Protocol
144
Xstatus Conference Presentation Resolution Height
144
Xstatus Conference Presentation Resolution Width
144
Xstatus Conference Presentation Siteid
144
Xstatus Conference Presentation Localsource
144
Xstatus Conference Presentation Localsendingmode
144
Xstatus Conference Presentation Lastlocalsource
145
Xstatus Conference Presentation Instance [N] Localsendingmode
145
Xstatus Conference Presentation Instance [N] Localsource
145
Xstatus Conference Site [N] Capabilities FECC Numberofpresets
145
Xstatus Conference Site [N] Capabilities FECC Numberofsources
145
Xstatus Conference Site [N] Capabilities FECC Source [N] Name
145
Xstatus Conference Site [N] Capabilities FECC Source [N] Sourceid
145
Xstatus Conference Site [N] Capabilities FECC Mode
146
Xstatus Conference Site [N] Capabilities FECC Source [N] Options
146
Xstatus Conference Site [N] Capabilities Presentation
146
Xstatus Conference Site [N] Manufacturer
146
Xstatus Conference Site [N] Microphonesmuted
146
Xstatus Conference Site [N] Softwareid
146
Xstatus Conference Site [N] Blackscreencause
147
Xstatus Conference Site [N] Bookingid
147
Xstatus Conference Site [N] Conferenceextended
147
Xstatus Conference Site [N] Securitystatus
147
Xstatus Conference Site [N] Unattendedtransfer
147
Xstatus Conference Line [N] Appearance Status
148
Xstatus Conference Line [N] Mode
148
Xstatus Conference Site [N] Appearance
148
Xstatus Conference Site [N] Attendedtransfer
148
Xstatus Conference Site [N] Caltext
148
Xstatus Conference Site [N] GCI
148
Xstatus Conference Site [N] Hold
148
Xstatus Conference Site [N] Preserved
148
Xstatus Conference Activespeaker Manual Siteid
149
Xstatus Conference Activespeaker Mode
149
Xstatus Conference Activespeaker Siteid
149
Xstatus Conference Donotdisturb
149
Xstatus Conference Line [N] Appearance GCI
149
Xstatus Conference Line [N] Appearance URI
149
Xstatus Conference Multipoint Mode
149
Xstatus Conference Selectedcallprotocol
150
Xstatus Diagnostics
153
Xstatus Diagnostics Call [N] Channels Incomingaudiochannel [N] Netstat 1 Bytes
153
Xstatus Diagnostics Call [N] Channels Incomingdatachannel [N] Netstat 1 Bytes
153
Xstatus Diagnostics Call [N] Channels Incomingvideochannel [N] Netstat 1 Bytes
153
Xstatus Diagnostics Call [N] Channels Outgoingaudiochannel [N] Netstat 1 Bytes
153
Xstatus Diagnostics Call [N] Channels Outgoingaudiochannel [N] Netstat 1 Drop
153
Xstatus Diagnostics Call [N] Channels Outgoingdatachannel [N] Netstat 1 Drop
153
Xstatus Diagnostics Call [N] Channels Outgoingvideochannel [N] Netstat 1 Bytes
153
H323 Status
156
Xstatus ICE Configured
157
Xstatus ICE Defaultcandidate
157
Xstatus ICE Turn IP
157
Xstatus ICE Turn Hostname
158
Xstatus ICE Turn Username
158
Xstatus ICE Turn Transport
158
Xstatus ICE Call Result
158
Xstatus ICE Call Local Candidate
158
Xstatus ICE Call Local IP
158
Xstatus ICE Call Remote Candidate
159
Xstatus ICE Call Remote IP
159
Xstatus ICE Turn Discovermode
159
Xstatus ICE Turn Bandwidth
159
Xstatus Diagnostics Call [N] Channels Outgoingvideochannel [N] Netstat 1 Drop
153
Logging Status
160
Xstatus Logging Extendedlogging Mode
160
Mediachannels Status
160
Xstatus Mediachannels
160
Xstatus Mediachannels Call [N] Incomingaudiochannel [N] Encryption Status
160
Xstatus Mediachannels Call [N] Incomingaudiochannel [N] Audio Protocol
160
Xstatus Mediachannels Call [N] Incomingaudiochannel [N] Audio Mute
161
Xstatus Mediachannels Call [N] Incomingaudiochannel [N] Audio Channels
161
Xstatus Mediachannels Call [N] Incomingaudiochannel [N] Transport RTP Local Ipaddress
161
Xstatus Mediachannels Call [N] Incomingaudiochannel [N] Transport RTP Local Port
161
Xstatus Mediachannels Call [N] Incomingaudiochannel [N] Transport RTP Remote Ipaddress
161
Xstatus Mediachannels Call [N] Incomingaudiochannel [N] Transport RTP Remote Port
161
Xstatus Mediachannels Call [N] Incomingaudiochannel [N] Transport RTCP Local Ipaddress
162
Xstatus Mediachannels Call [N] Incomingaudiochannel [N] Transport RTCP Local Port
162
Xstatus Mediachannels Call [N] Incomingaudiochannel [N] Transport RTCP Remote Ipaddress
162
Xstatus Mediachannels Call [N] Incomingaudiochannel [N] Transport RCTP Remote Port
162
Xstatus Mediachannels Call [N] Incomingvideochannel [N] Encryption Status
162
Xstatus Mediachannels Call [N] Incomingvideochannel [N] Channelrole
162
Xstatus Mediachannels Call [N] Incomingvideochannel [N] Video Protocol
163
Xstatus Mediachannels Call [N] Incomingvideochannel [N] Video Framerate
163
Xstatus Mediachannels Call [N] Incomingvideochannel [N] Video Resolutionx
163
Xstatus Mediachannels Call [N] Incomingvideochannel [N] Video Resolutiony
163
Xstatus Mediachannels Call [N] Incomingvideochannel [N] Transport RTP Local Ipaddress
163
Xstatus Mediachannels Call [N] Incomingvideochannel [N] Transport RTP Local Port
163
Xstatus Mediachannels Call [N] Incomingvideochannel [N] Transport RTP Local Protocol
170
Xstatus Mediachannels Call [N] Incomingvideochannel [N] Transport RTP Remote Protocol
170
Xstatus Mediachannels Call [N] Outgoingaudiochannel [N] Transport RTCP Local Protocol
170
Xstatus Mediachannels Call [N] Outgoingaudiochannel [N] Transport RTCP Remote Protocol
171
Xstatus Mediachannels Call [N] Outgoingaudiochannel [N] Transport RTP Local Protocol
171
Xstatus Mediachannels Call [N] Outgoingaudiochannel [N] Transport RTP Remote Protocol
171
Xstatus Mediachannels Call [N] Outgoingvideochannel [N] Transport RTCP Local Protocol
171
Xstatus Mediachannels Call [N] Outgoingvideochannel [N] Transport RTCP Remote Protocol
172
Xstatus Mediachannels Call [N] Outgoingvideochannel [N] Transport RTP Local Protocol
172
Xstatus Mediachannels Call [N] Outgoingvideochannel [N] Transport RTP Remote Protocol
172
Network Status
173
Xstatus Network
173
Xstatus Network 1 Ethernet Macaddress
173
Xstatus Network 1 Ethernet Speed
173
Xstatus Network 1 Ipv4 Address
173
Xstatus Network 1 Ipv4 Subnetmask
173
Xstatus Network 1 Ipv4 Gateway
173
Xstatus Network 1 Ipv4 DNS Domain Name
173
Xstatus Network 1 Ipv4 DNS Server [1..5] Address
173
Xstatus Network 1 Ipv4 DHCP Tftpserveraddress
174
Xstatus Network 1 Ipv4 DHCP Tmsserver
174
Xstatus Network 1 Ipv4 DHCP Provisioningserver
174
Xstatus Network 1 Ipv4 DHCP Provisioningdomain
174
Xstatus Network 1 Ipv4 DHCP Tftpserver
174
Xstatus Network 1 Ipv6 Address
174
Xstatus Network 1 Ipv6 Gateway
175
Xstatus Network 1 MTU
175
Xstatus Network 1 VLAN Voice Vlanid
175
Xstatus Network 1 CDP Platform
175
Xstatus Network 1 CDP Version
175
Xstatus Network 1 CDP Capabilities
175
Xstatus Network 1 CDP Deviceid
175
Xstatus Network 1 CDP Portid
176
Xstatus Network 1 CDP Duplex
176
Xstatus Network 1 CDP Vtpmgmtdomain
176
Xstatus Network 1 CDP Address
176
Xstatus Network 1 CDP Primarymgmtaddress
176
Xstatus Provisioning Software Previousupgrade Versionid
181
Xstatus Provisioning Software Previousupgrade URL
181
Xstatus Provisioning Software Upgradestatus Lastchange
181
Xstatus Provisioning Software Upgradestatus Status
181
Xstatus Provisioning Software Upgradestatus Phase
181
Xstatus Provisioning Software Upgradestatus Message
182
Xstatus Provisioning Software Upgradestatus Versionid
182
Xstatus Provisioning Software Upgradestatus URL
182
Xstatus Provisioning Software Upgradestatus Secondsuntilupgrade
182
Xstatus Provisioning Software Upgradestatus Sessionid
181
Xstatus Provisioning Software Current Versionid
182
Xstatus Provisioning Software Current URL
182
Xstatus Provisioning Software Current Completedat
183
Xstatus Provisioning CUCM CAPF Mode
183
Xstatus Provisioning CUCM CAPF Servername
183
Xstatus Provisioning CUCM CAPF Serverport
183
Xstatus Provisioning CUCM CAPF LSC
183
Xstatus Provisioning CUCM CAPF Operationstate
183
Xstatus Provisioning CUCM CAPF Operationresult
184
Xstatus Provisioning CUCM Provisionsecurity
184
Xstatus Provisioning CUCM Userid
184
Xstatus Provisioning CUCM CTL State
184
Xstatus Provisioning CUCM ITL State
185
Xstatus Provisioning CUCM Extensionmobility Enabled
185
Xstatus Provisioning CUCM Extensionmobility Loggedin
185
Xstatus Provisioning CUCM Extensionmobility Lastloggedinuserid
185
Xstatus Provisioning CUCM TVS Proxy [N] Server
185
Xstatus Provisioning CUCM TVS Proxy [N] Ipv6Address
185
Xstatus Provisioning CUCM TVS Proxy [N] Port
185
Xstatus Provisioning
185
Xstatus Provisioning CUCM TVS Proxy [N] Priority
185
Xstatus Provisioning CUCM Phonebook URL
186
Security Status
186
Xstatus Security
186
Xstatus Security FIPS Mode
186
Xstatus Security Persistency Configurations
186
Xstatus Security Persistency Callhistory
186
Xstatus Security Persistency Internallogging
187
Xstatus Systemunit Software Application
193
Xstatus Systemunit Software Maxaudiocalls
193
Xstatus Systemunit Software Releasekey
193
Xstatus Systemunit Software Optionkeys Naturalpresenter
194
Xstatus Systemunit Software Optionkeys Multisite
194
Xstatus Systemunit Software Optionkeys Premiumresolution
194
Xstatus Systemunit Software Optionkeys Highdefinition
194
Xstatus Systemunit Software Optionkeys Dualdisplay
194
Xstatus Systemunit Software Optionkeys Remotemonitoring
194
Xstatus Systemunit Hardware Module Serialnumber
194
Xstatus Systemunit Hardware Module Identifier
194
Xstatus Systemunit Hardware Mainboard Serialnumber
195
Xstatus Systemunit Hardware Mainboard Identifier
195
Xstatus Systemunit Hardware Bootsoftware
195
Xstatus Systemunit Hardware Monitoringsoftware
195
Xstatus Systemunit Hardware Monitoring Fan [N] Status
195
Xstatus Systemunit Hardware Temperature
195
Xstatus Systemunit Software Releasedate
193
Xstatus Systemunit Software Maxvideocalls
193
Xstatus Systemunit Software Version
193
Xstatus Systemunit Software Name
193
Xstatus Systemunit Hardware Temperaturethreshold
195
Xstatus Systemunit State System
196
Xstatus Systemunit State Maxnumberofcalls
196
Xstatus Systemunit State Maxnumberofactivecalls
196
Xstatus Systemunit State Numberofactivecalls
196
Xstatus Systemunit State Numberofsuspendedcalls
196
Xstatus Systemunit State Numberofinprogresscalls
196
Xstatus Systemunit State Subsystem Application
197
Xstatus Systemunit Contactinfo
197
Xstatus Systemunit Contactname
197
Xstatus Systemunit Notifications Notification [N] Type
197
Xstatus Systemunit Notifications Notification [N] Text
197
Xstatus Systemunit
197
Xstatus Systemunit Diagnostics Lastrun
198
Xstatus Systemunit Diagnostics Message [N] Type
198
Xstatus Systemunit Diagnostics Message [N] Level
198
Xstatus Systemunit Diagnostics Message [N] Description
198
Xstatus Systemunit Diagnostics Message [N] References
198
Startup Script
212
Cisco Telepresence Remote Control
213
Remote Control Key Map
214
The Systemtools Commands
215
About Disconnect Cause Types
217
5
Based on 1 rating
Ask a question
Give review
Questions and Answers:
Need help?
Do you have a question about the Cisco TelePresence SX20 Codec and is the answer not in the manual?
Ask a question
Cisco TelePresence SX20 Codec Specifications
General
Brand
Cisco
Model
TelePresence SX20 Codec
Category
Conference System
Language
English
Related product manuals
Cisco TelePresence SX20
88 pages
TelePresence SX20 Quick Set
177 pages
TelePresence System Codec C40
50 pages
TelePresence System Codec C60
50 pages
TelePresence System Codec C-Series
50 pages
Cisco TelePresence SX10
38 pages
Cisco TelePresence SX80
231 pages
Cisco C20 TelePresence System
127 pages
Cisco Telepresence System EX60
75 pages
TelePresence System Profile Series
50 pages
Cisco Telepresence MX200
11 pages
Cisco TelePresence Profile 55
2 pages
To Next PageTo Next Page
Need help?
General
