Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 223
API reference
Cisco TelePresence MCU API 2.9
Page 40 of 223
conference.metadata.status
Returns the metadata stored against the conference referenced by the supplied
conferenceName parameter.
Input parameters
Required inputs
Parameter name
Type
Short description
conferenceName
string
The name of the conference.
Returned data
Parameter name
Type
Short description
metadata
string
(4095)
A string of up to 4095 unicode characters stored on the
device and associated with the named conference.
conference.modify
This call modifies the settings of an existing conference. Conferences created through the management API
will appear in the list of conferences accessible via the web interface. Therefore, the API can be used to
modify conferences scheduled via the web interface, and vice versa.
This call returns an error if both
maximumVideoPorts and maximumAudioPorts are set to or if the total
number of ports exceeds the maximum conference size (currently 80). The maximum conference size check
is also performed for reserved ports.
Input parameters
Required inputs
Parameter name
Type
Short description
conferenceName
string
The name of the conference.
Optional or conditional inputs
Parameter name
Type
Short description
newConferenceName
string
The new conference name.
numericId
string
The numeric ID of the conference. Used for registration
with H.323 gatekeeper / SIP registrar, and to dial in to the
conference.
guestNumericId
string
If it is configured, this value is used by guests (instead of
numericId) to access the conference.
pin
string
The PIN for this conference. A string of numeric digits that
must be entered to access the conference.