Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 120
API reference 
Cisco TelePresence MCU API 2.8 
Page 22 of 120
 
addressBookEntry.enumerate 
Enumerates configured endpoints on the MCU. 
Parameter 
Type 
Comments 
Optional parameters 
enumerateID 
String 
The value returned by the last enumeration 
call. If it is omitted, a new enumeration is 
started. 
 
This call returns the following: 
Response 
Type 
Comments 
addressBookEntries 
Array 
See below for details. 
Optional parameters 
enumerateID 
String 
The value that should be used in the next 
call to get the next set of data. If this is 
omitted, no further data is available from 
the MCU. 
 
The array “addressBookEntries” contains structures with the following fields: 
Field 
Type 
Comments 
Name 
String 
The configuration’s name. 
address  
String  
The participant’s E.164 directory number, 
hostname or IP address. 
protocol 
String 
One of h323, sip or vnc. 
gatewayName 
String 
Present for H.323 endpoints which are 
configured to use a gateway. This name 
corresponds to the name of a gateway 
returned via gateway.enumerate. 
gatewayAddress 
String 
Present for H.323 endpoints which are 
configured to use a gateway. This is the 
address of the gateway this endpoint is 
configured to use. 
useSIPRegistrar 
Boolean 
Whether this endpoint is configured to use 
a SIP registrar when being called. 
password 
String 
The password for VNC endpoints.