Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 120
API reference 
Cisco TelePresence MCU API 2.8 
Page 44 of 120
 
Field 
Type 
Comments 
terminationDate(optional) 
dateTime.iso8601 
If terminationType is endOnGivenDay, this 
is the day that the conference repetition will 
end on. 
The following timing values will be present for active conferences only 
activeStartTime 
dateTime.iso8601 
If the conference is currently active, these 
fields show the time span of the current 
activation. If the conference is permanent 
then “activeEndTime” will be absent. 
activeEndTime 
dateTime.iso8601 
activeConferenceId 
string 
A unique ID for the active instance of this 
conference; this conference will have this 
ID even if, for example, the conference is 
renamed while active, but each scheduled 
instance of this conference will have a 
different activeConferenceId. 
conference.floor.modify 
This call modifies the status of the conference floor control. 
Response 
Type 
Comments 
conferenceName 
String 
The name of the conference to affect. 
floorStatus 
String  
‘inactive’ if no floor status is enabled, ‘active’ if an 
endpoint has floor control, or ‘assign’ if the chair or API 
had assigned floor control. 
Optional parameters 
floorParticipant  
Struct 
If floorStatus is not ‘inactive’ then the participant 
identification structure will contain participantName, 
participantType, and participantProtocol.  
conference.floor.query 
This call queries the status of the conference floor control. 
Response 
Type 
Comments 
enabled 
Boolean 
Whether box wide and conference settings allow floor 
control to be assigned. 
floorStatus 
String  
‘inactive’ if no floor status is enabled, ‘active’ if an 
endpoint has floor control, or assigned if the chair or 
API had assigned floor control. 
Optional parameters