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.
| Name | Type | Description | Attributes |
|---|---|---|---|
| atomLinkList | Array of Link | See Definition of Link | |
| plcmCascadeLinkList | Array of PlcmCascadeLink | See Definition of PlcmCascadeLink | |
| conferenceIdentifier | ConferenceIdentifier | The unique identifier for this conference. This system assigned identifier is not meaningful. | Mandatory |
| dialInNumber | DialInNumber | The dial string that can be used to call into the conference. | Mandatory |
| conferenceRoomIdentifier | ConferenceRoomIdentifier | The unique identifier for the conference room. This is the part of the dial in number after the prefix. | Mandatory |
| mcuName | McuName | The name of the MCU hosting the conference or the name of the hub MCU if this is a cascaded conference. | Mandatory |
| cascadeMcuName | Array of CascadeMcuName | If this is a cascaded conference, the names of the hosting MCUs. | |
| ownerFirstName | OwnerFirstName | The conference owner's first name. It is set to be the same as conference room owner's first name. | Mandatory |
| ownerLastName | OwnerLastName | The conference owner's last name. It is set to be the same as conference room owner's last name. | Mandatory |
| hostName | HostName | The hostname of the conference host. | Mandatory |
| recordingActive | boolean | Indicates whether the conference is currently being recorded. | |
| displayText | string | The display text of the conference. | |
| passback | Passback | User defined value for that is opaque to the system provided by the rest/conference/start-conference passback value. | |
| passthru | Passthru | 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. | |
| entityTag | EntityTag | 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. | |
| supportedLayout | Array of SupportedLayout | The names of the supported video layouts defined by the MCU hosting the conference. | |
| currentLayout | CurrentLayout | The name of the current video layout used by the MCU for the conference. | |
| conferenceLocked | boolean | Indicates whether the conference is currently locked, preventing new participants to enter the conference. | |
| joinNewCallsMuted | boolean | Indicates whether the conference will audio mute new callers. | |
| startTime | dateTime | Mandatory |
| Name | Type | Restrictions |
|---|---|---|
| CurrentLayout | string | Length of value must be >=1 Length of value must be <=128 |
| SupportedLayout | string | Length of value must be >=1 Length of value must be <=128 |
| EntityTag | string | Length of value must be >=1 Length of value must be <=64 |
| Passthru | string | Length of value must be >=1 Length of value must be <=512 |
| Passback | string | Length of value must be >=1 Length of value must be <=512 |
| HostName | string | Length of value must be >=1 Length of value must be <=128 |
| OwnerLastName | string | Length of value must be >=1 Length of value must be <=64 |
| OwnerFirstName | string | Length of value must be >=1 Length of value must be <=64 |
| CascadeMcuName | string | Length of value must be >=1 Length of value must be <=128 |
| McuName | string | Length of value must be >=1 Length of value must be <=128 |
| ConferenceRoomIdentifier | string | Length of value must be >=1 Length of value must be <=128 |
| DialInNumber | string | Length of value must be >=1 Length of value must be <=128 |
| ConferenceIdentifier | string | Length of value must be >=1 Length of value must be <=128 |