PlcmConferenceRoom

PlcmConferenceRoom

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+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.


PlcmConferenceRoom Fields

NameTypeDescriptionAttributes
atomLinkList Array of LinkSee Definition of Link
plcmDialOutParticipantList Array of PlcmDialOutParticipantSee Definition of PlcmDialOutParticipant
ownerFirstNameOwnerFirstName The conference room owner's first name. This is a 'read only' field. Sending it to the API will have no effect.
ownerLastNameOwnerLastName The conference room owner's last name. This is a 'read only' field. Sending it to the API will have no effect.
ownerDomainstring The domain the owner of this conference room belongs to Mandatory
ownerUsernamestring Owner's username. Mandatory
durationInMinutesint The number of minutes a conference is accessible. Duration is measured from the time the conference is started (joined by the first user).
conferenceRoomIdentifierConferenceRoomIdentifier 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.
dialInNumberstring 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.
conferenceTemplateNameConferenceTemplateName A meaningful name for the conference template (up to 50 characters).
maxParticipantsMaxParticipants 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.
mcuPoolOrderNamestring Name of the MCU pool order. Mandatory
territoryNamestring The name of the territory to which this conference room is assigned.
chairpersonRequiredboolean True if the chairperson is required for this conference, False otherwise.
chairpersonCodeChairpersonCode The code entered by the chairperson to chair the meeting in this conference room.
conferenceCodeConferenceCode The code required to enter this conference room.
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.
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.
autoDialOutboolean True if the list of dialout participants shall be dialed at conference initialization; False otherwise.
resourcePriorityNamespaceResourcePriorityNamespace Namespace parameter for the SIP Resource Priority header (namespace.value) for any SIP dial outs from the conference room. This is an optional value.
resourcePriorityValueResourcePriorityValue Value parameter for the SIP Resource Priority header (namespace.value) for any SIP dial outs from the conference room. This is an optional value.
firstCallerMcuAffinityboolean If the first caller's site contains MCUs in the designated MCU pool order, start the conference on one of them.
focusUriFocusUri The focusURI associated with this conference room (either SkypeForBusiness or Office365)
conferenceRoomTypeConferenceRoomType 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.
notBeforedateTime
notAfterdateTime


Nested Types/Restrictions


NameTypeRestrictions
ConferenceRoomTypestring
Value must be one of:
  • LOCAL
  • LOCAL_SCHEDULED
  • ENTERPRISE
  • ENTERPRISE_SCHEDULED
  • PCO_EVENT
FocusUristring
Length of value must be >=1
Length of value must be <=512
ResourcePriorityValuestring
Length of value must be >=1
Length of value must be <=64
ResourcePriorityNamespacestring
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
EntityTagstring
Length of value must be >=1
Length of value must be <=64
ConferenceCode
Length of value must be >=1
Length of value must be <=16
ChairpersonCode
Length of value must be >=1
Length of value must be <=16
MaxParticipantsint
ConferenceTemplateNamestring
Length of value must be >=1
Length of value must be <=50
ConferenceRoomIdentifier
Length of value must be >=0
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
T0string
Pattern of value must match the regular expression \d+
T1string
Pattern of value must match the regular expression \d+
T2string
Pattern of value must match the regular expression [0-9a-zA-Z~!@$%\*_\-\+={}\[\]\\/?\. ]*