Cisco Cisco TelePresence MCU 4510 Developer's Guide

API overview

Cisco TelePresence MCU API 2.9

Page 9 of 223

<value>

<int>22</int>

</value>

</member>

<member>

<name>faultString</name>

<value>

<string>no such recording</string>

</value>

</member>

</struct>

</value>

</fault>

</methodResponse>

The following parameters uniquely identify a particular participant for the purposes of many MCU API calls.

When reading or modifying the parameters of a specific endpoint, you must supply participantName,
participantProtocol and participantType, along with either a conferenceName or an autoAttendantUniqueId.

You can use participant.enumerate to retrieve these parameters.

string

The unique name of a participant.

string

h323, sip, or vnc.

string

One of: by_address, by_name, or ad_hoc.

string

The name of the conference.

If the participant is in a conference, the call may require the

conferenceName; if the participant is in an

autoattendant, the call may require the

autoAttendantUniqueId instead. The call will not require both

parameters.

string

Unique identifier for the auto attendant.

Enumerate methods have the potential to return a large volume of data, so these calls have a control
mechanism to limit the number of enumerated items per call.

Each enumerate call may take and return an

enumerateID parameter which tells the API or calling

application where to start the enumeration. The mechanism works as follows:

1. The application calls an enumerate method without an enumerateID parameter.

2. The device returns an array containing the enumerated items, and possibly an enumerateID. The response

will always include an enumerateID if the device enumerated more items than it included in the response.

3. If there is an enumerateID, the application should call the enumerate method again, supplying the

enumerateID as returned by the previous call.