D15335.02 Cisco TelePresence MX700 and MX800 API Reference Guide CE8.0, FEBRUARY 2016.
Copyright © 2016 Cisco Systems, Inc. All rights reserved. 27
Cisco TelePresence MX700 and MX800
API Reference Guide
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.
URL cheat sheet
The following table contains the main URLs used when accessing the API over HTTP.
Method URL Description
GET http://<ip-address>/status.xml Complete status document
GET http://<ip-address>/configuration.xml Complete configuration document
GET http://<ip-address>/command.xml Complete command document
GET http://<ip-address>/valuespace.xml Complete valuespace document
GET http://<ip-address>/getxml?location=<path> Retrieve document based on a path
POST http://<ip-address>/putxml Configurations and commands in HTTP body
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
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. Content-Type: text/xml. The body of the POST
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>
</Syste mUnit>
</Configuration>
Example 2: Setting the camera position.
Request
POST /putxml HTTP/1.1
Content-Type: text/xml
<Command>
<Camera>
<PositionSet command=”True”>
<Ca m eraId >1</Ca m eraId>
<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>
<Ca meraPositionSetResult item=”1” status=”OK”/>
</Command>