Using Http; Getting Status And Configurations; Sending Commands And Configurations; Using Http Post - Cisco TelePresence SX20 Codec Reference Manual

Cisco TelePresence SX20 Codec

Introduction

Using HTTP

The codec supports sending commands and configurations
over HTTP and HTTPS. It is also possible to retrieve configu-
rations and statuses this way. This interface exposes the same
API as the command line, but in XML format.

Getting status and configurations

Example 1: Get all status entries on the codec.
http://<ip-address>/getxml?location=/Status
Example 2: Get just the audio statuses of the codec.
http://<ip-address>/getxml?location=/Status/Audio
Example 3: Get all configurations of the codec.
http://<ip-address>/getxml?location=/Configuration
Example 4: Get all video configurations of the codec.
http://<ip-address>/getxml?location=/
Configuration/Video
SX20 Codec API Reference Guide CE8.1, APRIL 2016.
D15316.03
About the API About the API xConfiguration
URL cheat sheet
The following table contains the main URLs used when accessing the API over HTTP.
Method
GET
GET
GET
GET
GET
POST

Sending commands and configurations

Using HTTP POST

When sending configurations and commands to the codec,
it is important that the HTTP header Content-Type is set to
text/xml, i.e.
should contain the XML content.
Example 1: Changing the system name.
Request
POST /putxml HTTP/1.1
Content-Type: text/xml
<Configuration>
<SystemUnit>
<Name>newName</Name>
</SystemUnit>
</Configuration>
xCommand
URL
http://<ip-address>/status.xml
http://<ip-address>/configuration.xml
http://<ip-address>/command.xml
http://<ip-address>/valuespace.xml
http://<ip-address>/getxml?location=<path>
http://<ip-address>/putxml
Content-Type: text/xml. The body of the POST
32
xStatus
Description
Complete status document
Complete configuration document
Complete command document
Complete valuespace document
Retrieve document based on a path
Configurations and commands in HTTP body
Example 2: Setting the camera position.
Request
POST /putxml HTTP/1.1
Content-Type: text/xml
<Command>
<Camera>
<PositionSet command="True">
<CameraId>1</CameraId>
<Pan>200</Pan>
<Tilt>200</Tilt>
</PositionSet>
</Camera>
</Command>
Response
HTTP/1.1 200 OK
Content-Type: text/xml
Content-Length: 91
<?xml version="1.0"?>
<Command>
<CameraPositionSetResult item="1" status="OK"/>
</Command>
Copyright © 2016 Cisco Systems, Inc. All rights reserved.
API Reference Guide
Appendices