An active multipoint conference. Content-Type: application/vnd.plcm.plcm-conference-v3+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 |
---|---|---|---|
plcm-internal-params | plcm-internal-params | See Definition of plcm-internal-params | |
atomLinkList | List of link | See Definition of link | |
plcmCascadeLinkList | List of plcm-cascade-link | See Definition of plcm-cascade-link | |
conference-identifier | ConferenceIdentifier | The unique identifier for this conference. | Mandatory |
svc-cascade-partner-conference-identifier | SvcCascadePartnerConferenceIdentifier | The unique identifier for the conference with which this conference is in an AVC/SVC cascade.. | |
dial-in-number | DialInNumber | The dial string that can be used to call into the conference. | Mandatory |
conference-room-identifier | ConferenceRoomIdentifier | The unique identifier for the conference room. This is the part of the dial in number after the prefix. | Mandatory |
mcu-name | McuName | The name of the MCU hosting the conference or the name of the hub MCU if this is a cascaded conference. | Mandatory |
cascade-mcu-name | List of CascadeMcuName | If this is a cascaded conference, the names of the hosting MCUs. | |
owner-first-name | OwnerFirstName | The conference owner's first name. It is set to be the same as conference room owner's first name. | Mandatory |
owner-last-name | OwnerLastName | The conference owner's last name. It is set to be the same as conference room owner's last name. | Mandatory |
host-name | HostName | The hostname of the conference host. | Mandatory |
recording-active | xs:boolean | Indicates whether the conference is currently being recorded. | |
display-text | xs:string | The display text of the conference. | |
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. | |
entity-tag | 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. | |
supported-layout | List of SupportedLayout | The names of the supported video layouts defined by the MCU hosting the conference. | |
current-layout | CurrentLayout | The name of the current video layout used by the MCU for the conference. | |
conference-locked | xs:boolean | Indicates whether the conference is currently locked, preventing new participants to enter the conference. | |
join-new-calls-muted | xs:boolean | Indicates whether the conference will audio mute new callers. | |
focus-uri | xs:string | The conference Focus URI, if one exists. | |
call-count | xs:unsignedShort | The number of calls currently in this conference. | |
start-time | xs:dateTime | Mandatory | |
end-time | xs:dateTime |
Name | Type | Restrictions |
---|---|---|
CurrentLayout | xs:string | Length of value must be >=1 Length of value must be <=128 |
SupportedLayout | xs:string | Length of value must be >=1 Length of value must be <=128 |
EntityTag | xs:string | Length of value must be >=1 Length of value must be <=64 |
Passthru | xs:string | Length of value must be >=1 Length of value must be <=512 |
Passback | xs:string | Length of value must be >=1 Length of value must be <=512 |
HostName | xs:string | Length of value must be >=1 Length of value must be <=128 |
OwnerLastName | xs:string | Length of value must be >=1 Length of value must be <=64 |
OwnerFirstName | xs:string | Length of value must be >=1 Length of value must be <=64 |
CascadeMcuName | xs:string | Length of value must be >=1 Length of value must be <=128 |
McuName | xs:string | Length of value must be >=1 Length of value must be <=128 |
ConferenceRoomIdentifier | xs:string | Length of value must be >=1 Length of value must be <=128 |
DialInNumber | xs:string | Length of value must be >=1 Length of value must be <=128 |
SvcCascadePartnerConferenceIdentifier | xs:string | Length of value must be >=1 Length of value must be <=128 |
ConferenceIdentifier | xs:string | Length of value must be >=1 Length of value must be <=128 |