Cisco Cisco TelePresence MCU 4510 Developer's Guide

API reference 

Cisco TelePresence MCU Remote Management API Reference Guide  

Page 51 of 89

 

Returns data about participants in conferences on the MCU. Several calls may be required to receive 
data about all participants; see the notes on enumerateID below. 

Note: The participant.enumerate call has deprecated behaviour if there is no operationScope 
parameter in the call. See participant.enumerate on page 68. 

operationScope 

array of strings 

This should contain none, either or both of currentState 
or configuredState. If currentState is present, the active 
configuration of each participant is returned by the 
MCU in the currentState structure. If configuredState is 
present, the stored configuration is returned in the 
configuredState structure 

Optional parameters 

enumerateFilter  

String 

An enumerate filter string. 

enumerateID 

String 

The value returned by the last enumeration call. If this 
parameter is omitted, a new enumeration is started. 

Valid expressions within the enumerate filter are as follows: 

connected 

Boolean 

True if the participant is currently connected to a 
conference. 

disconnected 

Boolean 

True if the participant has been connected to a 
conference, but is now disconnected. 

connecting 

Boolean 

True if the scheduled participant is in the process of 
connecting. 

Note: A participant that has not yet connected to a conference (for example,. they have deferred 
connection specified) is neither connected nor disconnected. 

This call response returns the following: 

participants 

Array 

See below for details. 

enumerateID 

String 

The value which should be used in the next call to get 
the next set of data. If this is not present, there is no 
further data available from the MCU.