Copyright © TANDBERG 2008
Reference Guide Version 3.0 rev 3.0
11
Response
Type
Comments
currently configured SIP proxy.
conferenceRegistration
String
This value is only present if the device being
queried is an MCU. It will be
enabled
if
the MCU is configured to register
conferences’ numeric IDs with the
configured SIP registrar, and
disabled
if
not. The
enabled
value corresponds to
“SIP registration settings” being set to
“Allow conference registration” on the
Settings > SIP
page.
3.7
addressBookEntry.enumerate
Enumerates configured endpoints on an MCU or IP VCR.
Parameter
Type
Comments
enumerateID
(optional)
String
The value returned by the last enumeration call. If it is
omitted, a new enumeration is started.
This method returns:
Response
Type
Comments
enumerateID
(optional)
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.
addressBookEntries
array of structs
See below for details.
The array “addressBookEntries” contains structs with the following fields:
Field
Type
Comments
Name
String
The configuration’s name.
address
String (< 32
chars)
The participant’s E.164 directory
number, hostname or IP address.
protocol String
One
of
h323
,
sip
or
vnc
.
gatewayName String
Present
for h323 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 h323 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.
portNumber
Integer
The port number for vnc endpoints.
callInParams
struct
See below for details.
conferencingParameters
struct
See below for details.
The structure callInParams contains the following fields. This is used to match incoming participants to
endpoint configurations. For a positive match a participant must match fields which have values. Blank fields
are not considered in the comparison.
