Cisco Cisco TelePresence MCU 4510 Developer's Guide
conference.status
Returns information about a named conference on the MCU.
This call returns an error if both maximumVideoPorts and maximumAudioPorts are set to 0 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.
number of ports exceeds the maximum conference size (currently 80). The maximum conference size check
is also performed for reserved ports.
The MCU returns a “no such conference” fault if it can not find a conference with the supplied
conferenceName
conferenceName
.
Input parameters
Required inputs
Parameter name
Type
Short description
conferenceName
string
The name of the conference.
Returned data
A struct containing the status parameters of the named conference.
Parameter name
Type
Short description
conferenceName
string
The name of the conference.
conferenceType
string
Indicates whether a conference is or was scheduled, or
ad_hoc
ad_hoc
(which means it was started without being
scheduled).
uniqueId
integer
An ID that is unique among all scheduled and ad hoc
conferences. Each instance of a repeating conference has
the same uniqueId.
conferences. Each instance of a repeating conference has
the same uniqueId.
conferenceActive
boolean
Indicates whether conference is currently active. true if
the conference is currently active. false if the conference
is currently inactive.
the conference is currently active. false if the conference
is currently inactive.
Permanent conferences are always active; completed
conferences, or those that have not yet started, are
inactive.
conferences, or those that have not yet started, are
inactive.
description
string
Additional information about the conference.
pin
string
The PIN for this conference. A string of numeric digits that
must be entered to access the conference.
must be entered to access the conference.
guestPin
string
Security PIN that a guest can use to gain access to this
conference.
conference.
numericId
string
The numeric ID of the conference. Used for registration
with H.323 gatekeeper / SIP registrar, and to dial in to the
conference.
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
numericId
) to access the conference.
Cisco TelePresence MCU API 2.10
Page 66 of 296
API commands
conference.status