PlcmConference

PlcmConference

An active multipoint conference. Content-Type: application/vnd.plcm.plcm-conference+xml. All attributes are used in ETag calculation except for owner-first-name, owner-last-name, entity-tag and atom-link.


PlcmConference Fields

NameTypeDescriptionAttributes
atomLinkList Array of LinkSee Definition of Link
plcmCascadeLinkList Array of PlcmCascadeLinkSee Definition of PlcmCascadeLink
conferenceIdentifierConferenceIdentifier The unique identifier for this conference. This system assigned identifier is not meaningful. Mandatory
dialInNumberDialInNumber The dial string that can be used to call into the conference. Mandatory
conferenceRoomIdentifierConferenceRoomIdentifier The unique identifier for the conference room. This is the part of the dial in number after the prefix. Mandatory
mcuNameMcuName The name of the MCU hosting the conference or the name of the hub MCU if this is a cascaded conference. Mandatory
cascadeMcuNameArray of CascadeMcuName If this is a cascaded conference, the names of the hosting MCUs.
ownerFirstNameOwnerFirstName The conference owner's first name. It is set to be the same as conference room owner's first name. Mandatory
ownerLastNameOwnerLastName The conference owner's last name. It is set to be the same as conference room owner's last name. Mandatory
hostNameHostName The hostname of the conference host. Mandatory
recordingActiveboolean Indicates whether the conference is currently being recorded.
displayTextstring The display text of the conference.
passbackPassback User defined value for that is opaque to the system provided by the rest/conference/start-conference passback value.
passthruPassthru User defined value that is opaque to the system provided by the rest/conferences/start-conference passthru value. Note: this value is available after the conference is terminated in the userDataC field in the conference CDR.
entityTagEntityTag The unique value generated from the server object instance. This value is the same value that be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance.
supportedLayoutArray of SupportedLayout The names of the supported video layouts defined by the MCU hosting the conference.
currentLayoutCurrentLayout The name of the current video layout used by the MCU for the conference.
conferenceLockedboolean Indicates whether the conference is currently locked, preventing new participants to enter the conference.
joinNewCallsMutedboolean Indicates whether the conference will audio mute new callers.
startTimedateTimeMandatory


Nested Types/Restrictions


NameTypeRestrictions
CurrentLayoutstring
Length of value must be >=1
Length of value must be <=128
SupportedLayoutstring
Length of value must be >=1
Length of value must be <=128
EntityTagstring
Length of value must be >=1
Length of value must be <=64
Passthrustring
Length of value must be >=1
Length of value must be <=512
Passbackstring
Length of value must be >=1
Length of value must be <=512
HostNamestring
Length of value must be >=1
Length of value must be <=128
OwnerLastNamestring
Length of value must be >=1
Length of value must be <=64
OwnerFirstNamestring
Length of value must be >=1
Length of value must be <=64
CascadeMcuNamestring
Length of value must be >=1
Length of value must be <=128
McuNamestring
Length of value must be >=1
Length of value must be <=128
ConferenceRoomIdentifierstring
Length of value must be >=1
Length of value must be <=128
DialInNumberstring
Length of value must be >=1
Length of value must be <=128
ConferenceIdentifierstring
Length of value must be >=1
Length of value must be <=128