plcm-conference-v4.xsd Documentation

Imported Namespaces

Target Namespace

Elements

plcm-conference-v4  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.


Complex Types

PlcmConferenceV4 Fields

NameTypeDescriptionAttributes
plcm-internal-params plcm-internal-paramsSee Definition of plcm-internal-params
atomLinkList List of linkSee Definition of link
plcmCascadeLinkList List of plcm-cascade-linkSee Definition of plcm-cascade-link
conference-identifierConferenceIdentifier The unique identifier for this RPRM conference. Mandatory
dial-in-numberDialInNumber 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;
conference-room-identifierConferenceRoomIdentifier 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.
mcu-nameMcuName 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.
cascade-mcu-nameList of CascadeMcuName If this is a cascaded conference, the names of the hosting MCUs.
owner-first-nameOwnerFirstName 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.
owner-last-nameOwnerLastName 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.
host-nameHostName The hostname of the conference host.
recording-activexs:boolean Indicates whether the conference is currently being recorded.
display-textxs:string 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.
entity-tagEntityTag 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.
supported-layoutList of SupportedLayout The names of the supported video layouts defined by the MCU hosting the conference.
current-layoutCurrentLayout The name of the current video layout used by the MCU for the conference.
conference-lockedxs:boolean Indicates whether the conference is currently locked, preventing new participants to enter the conference.
join-new-calls-mutedxs:boolean Indicates whether the conference will audio mute new callers.
focus-urixs:string The conference Focus URI, if one exists.
connection-type-enumConnectionTypeEnum The type of on-going conference in RPRM. MCU, Pool, EMCU, Point2Point
conference-numeric-identifierxs:string The numeric conference identifier for MCU conference.
conference-dma-identifierxs:string The DMA conference identifier for pool conference.
is-reserved-conferencexs:boolean Indicates whether the conference is scheduled in advanced in RPRM.
birdge-identifierxs:string The identifier for MCU.
media-type-enumMediaTypeEnum Media-type of conference. Audio only or video conference
conference-mode-enumConferenceModeEnum AVCOnly is : CP (Continuous Presence), MediaRelayOnly is : SVC Only, MixAVCAndMediaRelay is : CP and SVC, MixAVCAndMediaRelayVSW is : VSW (Video Switching), Unknown.
areaxs:string Area attribute will be returned based on the MulitpleTenant feature status and the role of API client user.
start-timexs:dateTimeMandatory


Simple Types


NameTypeRestrictions
ConferenceModeEnumxs:string
Value must be one of:
  • AVCOnly
  • MediaRelayOnly
  • MixAVCAndMediaRelay
  • MixAVCAndMediaRelayVSW
  • Unknown
MediaTypeEnumxs:string
Value must be one of:
  • Audio
  • AudioVedio
ConnectionTypeEnumxs:string
Value must be one of:
  • MCU
  • POOL
  • EMCU
  • PointToPoint
CurrentLayoutxs:string
Length of value must be >=1
Length of value must be <=128
SupportedLayoutxs:string
Length of value must be >=1
Length of value must be <=128
EntityTagxs:string
Length of value must be >=1
Length of value must be <=64
Passthruxs:string
Length of value must be >=1
Length of value must be <=512
Passbackxs:string
Length of value must be >=1
Length of value must be <=512
HostNamexs:string
Length of value must be >=1
Length of value must be <=128
OwnerLastNamexs:string
Length of value must be >=1
Length of value must be <=64
OwnerFirstNamexs:string
Length of value must be >=1
Length of value must be <=64
CascadeMcuNamexs:string
Length of value must be >=1
Length of value must be <=128
McuNamexs:string
Length of value must be >=1
Length of value must be <=128
ConferenceRoomIdentifierxs:string
Length of value must be >=1
Length of value must be <=128
DialInNumberxs:string
Length of value must be >=1
Length of value must be <=128
ConferenceIdentifierxs:string
Length of value must be >=1
Length of value must be <=128