Cisco Cisco TelePresence MCU 4510 Developer's Guide

XML-RPC protocol overview 

Cisco TelePresence MCU API 2.8 

Page 16 of 120

 

The following parameters appear in the majority of conference control messages, and identify a 

specific participant on which operations are to be performed. The use of “MCU” below refers to any 

device which acts as a video conferencing server. 
 

participantName 

String 

This is an “internal” name, and therefore is not 

necessarily related to any name configured on an 

endpoint. Within the scope of a particular conference or 

auto attendant, the combination of “participantType”, 

“participantProtocol” and “participantName” is always 

unique. 

participantProtocol 

String 

Used in conjunction with “participantName” to uniquely 

identify a participant within a conference. Typically, these 

parameters should be treated as opaque values, but the 

current possibilities are: 
- for “participantProtocol”: 

h323 – an endpoint using the H.323 protocol 
vnc – a VNC connection (e.g. remote desktop) 
sip – an endpoint using the SIP protocol 

- for “participantType”: 

ad_hoc – this participant called into the MCU or 

was dialed out via the web interface and is not in 

the MCU’s endpoint list 
by_address – fully-specified participant added 

through the API 
by_name – MCU-configured endpoint 

irrespective of whether the endpoint dialed in or 

the MCU dialed out 

API-created participants in scheduled conferences (i.e. 

those originated by “participant.add”) will be of type 

by_address (unless they are added explicitly as 

temporary ad_hoc participants.) 

participantType 

String 

conferenceName 

String 

Unique conference name – the conference name space is 

shared between API-generated conferences and all other 

ad hoc and scheduled MCU conferences. 

autoAttendantUniqueId  String 

If the participant in question is connected to an auto 

attendant rather than a conference, this field contains a 

unique identifier for that auto attendant. 

When modifying or querying parameters for a specific endpoint, participantName, participantProtocol 

and participantType parameters are supplied, along with either a conferenceName or an 

autoAttendantUniqueId. The only safe way to find these values is to use the fields returned from 

participant.enumerate. 

Due to the potential for a very large number of responses, all enumerate functions return an 

enumerateID response. This contains a value which should be passed to subsequent calls of the 

same enumerate function in order to retrieve the remainder of the values.