Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 120
Introduction 
Cisco TelePresence MCU API 2.8 
Page 11 of 120
 
Introduction 
This reference guide contains the specification of the Cisco TelePresence MCU Series API, by which 
it is possible to control the following Cisco TelePresence products: 
 
MCU 4200 Series 
 
MCU 4500 Series 
 
MCU MSE 8420 
 
MCU MSE 8510 
This is accomplished via messages sent using the XML-RPC protocol. XML-RPC is a simple protocol 
for remote procedure calling using HTTP as the transport and XML as the encoding. It is designed to 
be as simple as possible, whilst allowing complex data structures to be transmitted, processed and 
returned. XML-RPC has no platform or software dependence and was chosen over SOAP because of 
its simplicity.  
In this implementation of XML-RPC all parameters and return values are part of a <struct> and are all 
explicitly named. For example, the device.query call returns the current time value as a structure 
member named currentTime rather than as a single value of type <dateTime.iso8601>. 
Note:
 Unless otherwise stated, assume string length is a maximum of 31 characters. 
For further details of XML-RPC refer to the 
 [1]. 
HTTP and HTTPS 
MCUs expect to receive HTTP communication over TCP/IP connections to port 80. The HTTP 
messages should be “POST”s to the URL “/RPC2”.  
HTTPS (HTTP secured by SSL) is supported on all MCU products from software version 2.3 and 
later. 
By default, HTTPS is provided on TCP port 443, although MCUs can be configured to receive HTTP 
and HTTPS connections on non-standard TCP port numbers if required. 
The MCUs implement HTTP/1.1 as defined by 
 [2].  
Clustering 
From Version 4.1 of the MCU, it is possible to configure MCU blades in a cluster in order to increase 
the number of HD conference participants. One MCU acts as a master controlling up to two slave 
MCUs.  
Consider API overhead when writing applications 
Every API command that your application sends incurs a processing overhead within the device’s 
own application. The exact amount of overhead varies widely with the command type and the 
parameters sent. It is important to bear this in mind when designing your application’s architecture 
and software. If the device receives a high number of API commands every second, its overall 
performance could be seriously impaired – in the same way that it would if be several users accessed 
it from the web interface simultaneously. 
The current implementation of the MCU API will accept a maximum of four concurrent XML RPC 
requests and is limited to a maximum of eight concurrent TCP connections.  
For this reason, the best architecture is a single server running the API application and sending 
commands to the device. If multiple users need to use the application simultaneously, provide a web 
interface on that server or write a client that communicates with the server. The server would then