An active multipoint conference. Content-Type: application/vnd.plcm.plcm-conference-v4+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 |
|---|---|---|---|
| plcmInternalParams | PlcmInternalParams | See Definition of PlcmInternalParams | |
| atomLinkList | Array of Link | See Definition of Link | |
| plcmCascadeLinkList | Array of PlcmCascadeLink | See Definition of PlcmCascadeLink | |
| conferenceIdentifier | ConferenceIdentifier | The unique identifier for this RPRM conference. | Mandatory |
| dialInNumber | DialInNumber | The dial string that can be used to call into the conference. For RPRM, The dial string that can be used to call into the conference: for Pool conference, it will be the perfix plus room identifier; for MCU conference, it will be the MCU IP address plus ## plus the numeric identifier; | |
| conferenceRoomIdentifier | ConferenceRoomIdentifier | The unique identifier for the conference room. This is the part of the dial in number after the prefix. For RPRM, The unique identifier for the conference room. This is the part of the dial in number after the prefix. Only apply for pool conference, for other type of conference it will be empty. | |
| mcuName | McuName | The name of the MCU hosting the conference or the name of the hub MCU if this is a cascaded conference. For RPRM, The name of the MCU hosting the conference or the name of the hub MCU if this is a cascaded conference. For EMCU or Point2Point conference, it will be empty. | |
| 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. For RPRM, If there is no owner for ad-hoc MCU call or p2p call, it will be empty. | |
| ownerLastName | OwnerLastName | The conference owner's last name. It is set to be the same as conference room owner's last name. For RPRM, If there is no owner for ad-hoc MCU call or p2p call, it will be empty. | |
| hostName | HostName | The hostname of the conference host. | |
| aJam | boolean | If the conference is a Jam (SVC EVO conference) or not. Jam conferences may not have some values set. It may only have identifier and dial in information. Participant information, and many other actions are handled via the Roster API, leaving REST for legacy AVC conferences. | |
| recordingActive | boolean | Indicates whether the conference is currently being recorded. | |
| displayText | string | The display text of the conference. For RPRM, Or conference name in RPRM. | |
| passback | Passback | User defined value for that is opaque to the system. | |
| 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. | |
| focusUri | string | The conference Focus URI, if one exists. | |
| connectionTypeEnum | ConnectionTypeEnum | The type of on-going conference in RPRM. MCU, Pool, EMCU, Point2Point | |
| conferenceNumericIdentifier | string | The numeric conference identifier for MCU conference. | |
| conferenceDmaIdentifier | string | The DMA conference identifier for pool conference. | |
| isReservedConference | boolean | Indicates whether the conference is scheduled in advanced in RPRM. | |
| birdgeIdentifier | string | The identifier for MCU. | |
| mediaTypeEnum | MediaTypeEnum | Media-type of conference. Audio only or video conference | |
| conferenceModeEnum | ConferenceModeEnum | AVCOnly is : CP (Continuous Presence), MediaRelayOnly is : SVC Only, MixAVCAndMediaRelay is : CP and SVC, MixAVCAndMediaRelayVSW is : VSW (Video Switching), Unknown. | |
| area | string | Area attribute will be returned based on the MulitpleTenant feature status and the role of API client user. | |
| startTime | dateTime | Mandatory |
| Name | Type | Restrictions |
|---|---|---|
| ConferenceModeEnum | string | Value must be one of:
|
| MediaTypeEnum | string | Value must be one of:
|
| ConnectionTypeEnum | string | Value must be one of:
|
| 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 |