PlcmConferenceV4

PlcmConferenceV4

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.


PlcmConferenceV4 Fields

NameTypeDescriptionAttributes
plcmInternalParams PlcmInternalParamsSee Definition of PlcmInternalParams
atomLinkList Array of LinkSee Definition of Link
plcmCascadeLinkList Array of PlcmCascadeLinkSee Definition of PlcmCascadeLink
conferenceIdentifierConferenceIdentifier The unique identifier for this RPRM conference. Mandatory
dialInNumberDialInNumber 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;
conferenceRoomIdentifierConferenceRoomIdentifier 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.
mcuNameMcuName 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.
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. For RPRM, If there is no owner for ad-hoc MCU call or p2p call, it will be empty.
ownerLastNameOwnerLastName 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.
hostNameHostName The hostname of the conference host.
aJamboolean 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.
recordingActiveboolean Indicates whether the conference is currently being recorded.
displayTextstring The display text of the conference. For RPRM, Or conference name in RPRM.
passbackPassback User defined value for that is opaque to the system.
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.
focusUristring The conference Focus URI, if one exists.
connectionTypeEnumConnectionTypeEnum The type of on-going conference in RPRM. MCU, Pool, EMCU, Point2Point
conferenceNumericIdentifierstring The numeric conference identifier for MCU conference.
conferenceDmaIdentifierstring The DMA conference identifier for pool conference.
isReservedConferenceboolean Indicates whether the conference is scheduled in advanced in RPRM.
birdgeIdentifierstring The identifier for MCU.
mediaTypeEnumMediaTypeEnum Media-type of conference. Audio only or video conference
conferenceModeEnumConferenceModeEnum AVCOnly is : CP (Continuous Presence), MediaRelayOnly is : SVC Only, MixAVCAndMediaRelay is : CP and SVC, MixAVCAndMediaRelayVSW is : VSW (Video Switching), Unknown.
areastring Area attribute will be returned based on the MulitpleTenant feature status and the role of API client user.
startTimedateTimeMandatory


Nested Types/Restrictions


NameTypeRestrictions
ConferenceModeEnumstring
Value must be one of:
  • AVCOnly
  • MediaRelayOnly
  • MixAVCAndMediaRelay
  • MixAVCAndMediaRelayVSW
  • Unknown
MediaTypeEnumstring
Value must be one of:
  • Audio
  • AudioVedio
ConnectionTypeEnumstring
Value must be one of:
  • MCU
  • POOL
  • EMCU
  • PointToPoint
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