Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 296
conference.floor.query
This call queries the status of the conference floor control.
Input parameters
Required inputs
Parameter name
Type
Short description
conferenceName
string
The name of the conference.
Returned data
Always returned
Parameter name
Type
Short description
enabled
boolean
true
if this feature or item is enabled.
floorStatus
string
One of inactiveactive, or assigned. If it is active or
assigned
, a floorParticipant struct will be included in
the response.
Conditionally returned
If floorStatus is not inactive, then the response includes a struct to identify which participant 'has
the floor'.
Parameter name
Type
Short description
floorParticipant
struct
A structure that identifies which participant has the floor.
participantName
string
The unique name of a participant.
participantProtocol
string
h323
sip, or vnc.
participantType
string
One of: by_addressby_name, or ad_hoc.
conferenceName
string
The name of the conference.
If the participant is in a conference, the response includes the conferenceName; if the participant is in an
autoattendant, the response includes the autoAttendantUniqueId instead. The response will not
include both parameters.
autoAttendantUniqueID
string
Unique identifier for the auto attendant.
connectionUniqueId
integer
Corresponds to the uniqueId returned by a conference
or autoattendant.
Cisco TelePresence MCU API 2.10
Page 54 of 296
API commands
conference.floor.query