plcm-conference-room-v4.xsd Documentation

Imported Namespaces

Target Namespace

Elements

plcm-conference-room-v4  PlcmConferenceRoomV4

A Conference Room. Conference Rooms are tied to individual user accounts and will be created during scheduling with start and stop times. Content-Type: application/vnd.plcm.plcm-conference-room-v4+xml. All attributes are used in ETag calculation except for owner-first-name, owner-last-name, not-before, not-after, entity-tag and atom-link.


Complex Types

PlcmConferenceRoomV4 Fields

NameTypeDescriptionAttributes
atomLinkList List of linkSee Definition of link
plcmConferenceRoomAliasList List of plcm-conference-room-aliasSee Definition of plcm-conference-room-alias
plcmDialOutParticipantV2List List of plcm-dial-out-participant-v2See Definition of plcm-dial-out-participant-v2
owner-first-nameOwnerFirstName The conference room owner's first name. This is a 'read only' field. Sending it to the API will have no effect.
owner-last-nameOwnerLastName The conference room owner's last name. This is a 'read only' field. Sending it to the API will have no effect.
owner-domainxs:string The domain to which the owner of this conference room belongs. Mandatory
owner-usernamexs:string Owner's username. Mandatory
duration-in-minutesDurationInMinutes The number of minutes a conference is accessible. Duration is measured from the time the conference is started (joined by the first user). Note: 1. This value only applies if the value override-default-duration-in-minutes is true. 2. If override-default-duration-in-minutes is true this value must not be 0. 3. Integer value '-1' will set the conference room to be accessible for unlimited duration.
conference-room-identifierConferenceRoomIdentifier The unique identifier of the conference room. If left blank, a conference room identifer will be generated. If supplied, the identifier must be unique, or the room will fail to be created. Can't be edited for an enterprise conference room or calendared meeting conference room.
conference-room-nameConferenceRoomName The name of the conference room when it is launched on the RMX. This is optional, and can be left blank
dial-in-numberxs:string The dial in number of this conference room. Automatically set to the dialing prefix plus room ID. This is a 'read only' field. Sending it to the API will have no effect. Modification of this field is not allowed.
conference-template-nameConferenceTemplateName A meaningful name for the conference template (up to 50 characters).
max-participantsMaxParticipants Maximum number (0-99) of callers allowed to join the conference. To specify the MCU's maximum, use -1. To specify the default conference settings, do not include the max-participants in the request.
mcu-pool-order-namexs:string Name of the MCU pool order. Mandatory
territory-namexs:string The name of the territory to which this conference room is assigned.
svc-only-territory-namexs:string The name of the svc-only territory to which this conference room is assigned.
chairperson-requiredxs:boolean True if the chairperson is required for this conference, False otherwise.
chairperson-codeChairpersonCode The code entered by the chairperson to chair the meeting in this conference room.
chairperson-code-use-as-aliasxs:boolean True if the chairperson code is to be used as alias, False otherwise. This will be ignored if 'chairperson-code' is empty or null.
conference-codeConferenceCode The code required to enter this conference room.
conference-code-use-as-aliasxs:boolean True if the conference code is to be used as alias, False otherwise. This will be ignored if 'conference-code' is empty or null.
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.
passbackPassback User defined value for that is opaque to the system.
passthruPassthru User defined value that that is opaque to the system. Note: this value is available after the call and/or conference is terminated in the userDataB field in the call and/or conference CDR.
auto-dial-outxs:boolean True if the list of dialout participants shall be dialed at conference initialization; False otherwise.
resource-priority-namespaceResourcePriorityNamespace Namespace parameter for the SIP Resource Priority header (namespace.value) for any SIP dial outs from the conference room. This is an optional value.
resource-priority-valueResourcePriorityValue Value parameter for the SIP Resource Priority header (namespace.value) for any SIP dial outs from the conference room. This is an optional value.
first-caller-mcu-affinityxs:boolean If the first caller's site contains MCUs in the designated MCU pool order, start the conference on one of them.
conf-room-publishablexs:boolean Whether this conference room is publishable on Lync systems.
override-last-disconnectxs:boolean If true, the conference will terminate at the end of conference duration instead of when the last participant leaves.
focus-uriFocusUri The focusURI associated with this conference room (either SkypeForBusiness or Office365)
conference-room-typeConferenceRoomType Distinguish whether this room is an enterprise, calendared (PCO), or scheduled VMR. NOTE: This is a 'read only' field. Sending it to the API will have no effect.
lync-registered-domainLyncRegisteredDomain The registered Lync domain associated with this conference room (either SkypeForBusiness or Office365); the rppContact is built with this domain; the rppContact is built with this domain.
override-default-conference-template-namexs:boolean This field has false value if default value is set for conference template name.
override-default-max-participantsxs:boolean This field has false value if default value is set for max participants.
override-default-duration-in-minutesxs:boolean This field has false value if default value is set for conference duration.
override-default-territory-namexs:boolean This field has false value if default value is set for territory.
override-default-svc-only-territory-namexs:boolean This field has false value if default value is set for svc-only territory.
override-default-mcu-pool-order-namexs:boolean This field has false value if default value is set for MCU pool order.
override-default-first-caller-mcu-affinityxs:boolean This field has false value if default value is set for MCU selection.
override-default-chairperson-passcodexs:boolean This field has false value if default value is set for chairperson passcode.
override-default-conference-passcodexs:boolean This field has false value if default value is set for conference passcode.
override-default-resource-priorityxs:boolean This field has false value if default value is set for resource priority.
override-default-conf-room-publishablexs:boolean This field has false value if default value is set for conference room publishable.
audio-mute-on-joinxs:boolean Endpoints join conference in audio mute mode
video-mute-on-joinxs:boolean Endpoints join conference in video mute mode
poly-evo-mute-lockxs:boolean True - Poly EVO endpoint will not be able to un-mute itself once joining the conference in video/audio mute mode (determined by audio-mute-on-join and video-mute-on-join) False - Poly EVO endpoint will be able to un-mute itself once joining the conference
poly-evo-challenge-unmute-by-controllerxs:boolean True - Poly EVO endpoint will be prompted to accept or reject an unmute operation made by a controller in the conference False - Poly EVO endpoint may be unmuted by a controller with no opportunity to reject the operation
not-beforexs:dateTime
not-afterxs:dateTime


Simple Types


NameTypeRestrictions
LyncRegisteredDomainxs:string
Length of value must be >=1
Length of value must be <=128
ConferenceRoomTypexs:string
Value must be one of:
  • LOCAL
  • LOCAL_SCHEDULED
  • ENTERPRISE
  • ENTERPRISE_SCHEDULED
  • PCO_EVENT
FocusUrixs:string
Length of value must be >=1
Length of value must be <=512
ResourcePriorityValuexs:string
Length of value must be >=1
Length of value must be <=64
ResourcePriorityNamespacexs: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
EntityTagxs:string
Length of value must be >=1
Length of value must be <=64
ConferenceCodeT0
Length of value must be >=1
Length of value must be <=16
ChairpersonCodeT1
Length of value must be >=1
Length of value must be <=16
MaxParticipantsxs:int
ConferenceTemplateNamexs:string
Length of value must be >=1
Length of value must be <=50
ConferenceRoomNameT2
Length of value must be >=0
Length of value must be <=50
ConferenceRoomIdentifierT3
Length of value must be >=0
Length of value must be <=128
DurationInMinutesxs:int
OwnerLastNamexs:string
Length of value must be >=1
Length of value must be <=256
OwnerFirstNamexs:string
Length of value must be >=1
Length of value must be <=256
T0xs:string
Pattern of value must match the regular expression \d+
T1xs:string
Pattern of value must match the regular expression \d+
T2xs:string
Pattern of value must match the regular expression ^[^,;]+$
T3xs:string
Pattern of value must match the regular expression (^[a-zA-Z0-9]([0-9a-zA-Z_~!$&,.'=\+\-\*\(\)]|%[0-9a-fA-F][0-9a-fA-F])*[a-zA-Z0-9]$)|(^$)