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.
| Name | Type | Description | Attributes |
|---|---|---|---|
| atomLinkList | List of link | See Definition of link | |
| plcmConferenceRoomAliasList | List of plcm-conference-room-alias | See Definition of plcm-conference-room-alias | |
| plcmDialOutParticipantV2List | List of plcm-dial-out-participant-v2 | See Definition of plcm-dial-out-participant-v2 | |
| owner-first-name | OwnerFirstName | The conference room owner's first name. This is a 'read only' field. Sending it to the API will have no effect. | |
| owner-last-name | OwnerLastName | The conference room owner's last name. This is a 'read only' field. Sending it to the API will have no effect. | |
| owner-domain | xs:string | The domain to which the owner of this conference room belongs. | Mandatory |
| owner-username | xs:string | Owner's username. | Mandatory |
| duration-in-minutes | DurationInMinutes | 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-identifier | ConferenceRoomIdentifier | 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-name | ConferenceRoomName | The name of the conference room when it is launched on the RMX. This is optional, and can be left blank | |
| dial-in-number | xs: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-name | ConferenceTemplateName | A meaningful name for the conference template (up to 50 characters). | |
| max-participants | MaxParticipants | 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-name | xs:string | Name of the MCU pool order. | Mandatory |
| territory-name | xs:string | The name of the territory to which this conference room is assigned. | |
| svc-only-territory-name | xs:string | The name of the svc-only territory to which this conference room is assigned. | |
| chairperson-required | xs:boolean | True if the chairperson is required for this conference, False otherwise. | |
| chairperson-code | ChairpersonCode | The code entered by the chairperson to chair the meeting in this conference room. | |
| chairperson-code-use-as-alias | xs: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-code | ConferenceCode | The code required to enter this conference room. | |
| conference-code-use-as-alias | xs: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-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. | |
| passback | Passback | User defined value for that is opaque to the system. | |
| passthru | Passthru | 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-out | xs:boolean | True if the list of dialout participants shall be dialed at conference initialization; False otherwise. | |
| resource-priority-namespace | ResourcePriorityNamespace | 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-value | ResourcePriorityValue | 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-affinity | xs:boolean | If the first caller's site contains MCUs in the designated MCU pool order, start the conference on one of them. | |
| conf-room-publishable | xs:boolean | Whether this conference room is publishable on Lync systems. | |
| override-last-disconnect | xs:boolean | If true, the conference will terminate at the end of conference duration instead of when the last participant leaves. | |
| focus-uri | FocusUri | The focusURI associated with this conference room (either SkypeForBusiness or Office365) | |
| conference-room-type | ConferenceRoomType | 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-domain | LyncRegisteredDomain | 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-name | xs:boolean | This field has false value if default value is set for conference template name. | |
| override-default-max-participants | xs:boolean | This field has false value if default value is set for max participants. | |
| override-default-duration-in-minutes | xs:boolean | This field has false value if default value is set for conference duration. | |
| override-default-territory-name | xs:boolean | This field has false value if default value is set for territory. | |
| override-default-svc-only-territory-name | xs:boolean | This field has false value if default value is set for svc-only territory. | |
| override-default-mcu-pool-order-name | xs:boolean | This field has false value if default value is set for MCU pool order. | |
| override-default-first-caller-mcu-affinity | xs:boolean | This field has false value if default value is set for MCU selection. | |
| override-default-chairperson-passcode | xs:boolean | This field has false value if default value is set for chairperson passcode. | |
| override-default-conference-passcode | xs:boolean | This field has false value if default value is set for conference passcode. | |
| override-default-resource-priority | xs:boolean | This field has false value if default value is set for resource priority. | |
| override-default-conf-room-publishable | xs:boolean | This field has false value if default value is set for conference room publishable. | |
| audio-mute-on-join | xs:boolean | Endpoints join conference in audio mute mode | |
| video-mute-on-join | xs:boolean | Endpoints join conference in video mute mode | |
| poly-evo-mute-lock | xs: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-controller | xs: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-before | xs:dateTime | ||
| not-after | xs:dateTime |
| Name | Type | Restrictions |
|---|---|---|
| LyncRegisteredDomain | xs:string | Length of value must be >=1 Length of value must be <=128 |
| ConferenceRoomType | xs:string | Value must be one of:
|
| FocusUri | xs:string | Length of value must be >=1 Length of value must be <=512 |
| ResourcePriorityValue | xs:string | Length of value must be >=1 Length of value must be <=64 |
| ResourcePriorityNamespace | 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 |
| EntityTag | xs:string | Length of value must be >=1 Length of value must be <=64 |
| ConferenceCode | T0 | Length of value must be >=1 Length of value must be <=16 |
| ChairpersonCode | T1 | Length of value must be >=1 Length of value must be <=16 |
| MaxParticipants | xs:int | |
| ConferenceTemplateName | xs:string | Length of value must be >=1 Length of value must be <=50 |
| ConferenceRoomName | T2 | Length of value must be >=0 Length of value must be <=50 |
| ConferenceRoomIdentifier | T3 | Length of value must be >=0 Length of value must be <=128 |
| DurationInMinutes | xs:int | |
| OwnerLastName | xs:string | Length of value must be >=1 Length of value must be <=256 |
| OwnerFirstName | xs:string | Length of value must be >=1 Length of value must be <=256 |
| T0 | xs:string | Pattern of value must match the regular expression \d+ |
| T1 | xs:string | Pattern of value must match the regular expression \d+ |
| T2 | xs:string | Pattern of value must match the regular expression ^[^,;]+$ |
| T3 | xs: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]$)|(^$) |