Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 223
API reference
Cisco TelePresence MCU API 2.9
Page 78 of 223
Input parameters
Parameter name
Type
Short description
conferenceName
string
The name of the conference.
autoAttendantUniqueID
string
Unique identifier for the auto attendant.
participantName
string
The unique name of a participant.
participantProtocol
string
h323sip, or vnc.
participantType
string
One of: by_addressby_name, or ad_hoc.
participant.enumerate
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 device will respond to
participant.enumerate if you omit operationScope. However, this
behavior is deprecated and may not be supported in future versions. See
for details.
Input parameters
Required inputs
Parameter name
Type
Short description
operationScope
array
The array should contain one or two string parameters.
That is, it should contain either or both of the strings
currentState or configuredState.
Optional or conditional inputs
Parameter name
Type
Short description
enumerateID
string
The device returns this index if the requested data is too
large for one response. Pass this parameter in a repeat of
the call to return the next batch of data.
lastRevision
integer
This number identifies an earlier set of enumeration data to
compare against your current call. If you supply this
parameter using the currentRevision value returned by
a previous enumeration, the current enumerate call will
return only the differences since that previous call. If you
don't supply this parameter, the device assumes that you
want a full enumeration.
enumerateFilter
string
A filter expression. The enumeration results depend on the
supplied expression.
enumerateFilter filters on: