Cisco Cisco TelePresence MCU 4510 Developer's Guide

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.

4. The application should repeat this process until the response fails to include an enumerateID. This means

that the enumeration is complete.

Note: Do not supply your own enumerateID values; make sure you only use the values returned by the
device.

Enumerate methods will accept an optional enumerateFilter parameter, which allows you to filter the
response. The parameter must contain a filter expression, which is built from criteria and operators.

The filter criteria that a call will accept vary depending on the call, but the syntax for using those criteria in
expressions is the same for all methods that allow filtering. The reference information for methods that allow
filtering includes acceptable filter criteria.

If the filter expression evaluates to true for the enumerated item, the item will be included in the device's
response. If the expression evaluates false, the enumerated item will be filtered out of the response.

Filter expressions consist of atomic expressions combined with operators and parentheses. Whitespace is
ignored. Functions are valid, and any parameters are in a comma separated list in parentheses after the
function name, for example, function(expression1,expression2).

For example, if the expression (inProgress && internal) is used to filter the response to
recording.enumerate

, the returned array of recordings will only include those which are both

and internal.

The integer 0 evaluates to false and all other integers to true. Integers can be expressed using any string of
valid digits. Prefix hex digits with 0x, decimal with 0t and binary with 0z. The API assumes decimal if you
don't supply a prefix.

The following binary operators are valid, in order of priority (lowest priority first):

Cisco TelePresence MCU API 2.10

Page 11 of 296

Overview

Enumerate methods