Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 296
addressBookEntry.enumerate
Enumerates the configured endpoints on the MCU. Each struct in the addressBookEntries array
represents a known endpoint, and details its call in parameters and conferencing parameters in nested
structures.
Input parameters
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.
Returned data
Conditionally returned
If there are entries to return, the method returns them in an array. If there are more entries than can be
returned in one response, you'll get the next enumerateID up from the one you provided.
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.
addressBookEntries
array
Each array member is a struct representing a single
addressbook entry.
name (endpoint)
string
The name of the endpoint.
address (endpoint)
string (63) The address of the endpoint; may be hostname,
IP address, E.164 number, SIP URI, or H.323 ID.
protocol (signaling)
string
The signaling protocol used in the call. One of h323,
sip
, or vnc.
gatewayName
string
Present in entries for H.323 endpoints which are
configured to use a gateway. This name corresponds to
the name parameter of a gateway returned by
gateway.enumerate
.
gatewayAddress
string (63) The address of an H.323 gateway, if required. Only used
if protocol is h323. This corresponds to the address
parameter of the gateway as returned by
gateway.enumerate
.
Cisco TelePresence MCU API 2.10
Page 24 of 296
API commands
addressBookEntry.enumerate