CMA Reservation. It's used to reserve a conference in the future on CMA system.
| Name | Type | Description | Attributes |
|---|---|---|---|
| plcmSchedRecurrence | PlcmSchedRecurrence | See Definition of PlcmSchedRecurrence | |
| atomLinkList | Array of Link | See Definition of Link | |
| plcmReservedParticipantList | PlcmReservedParticipantList | See Definition of PlcmReservedParticipantList | Mandatory |
| name | Name | The reservation name. | Mandatory |
| reservationIdentifier | string | Identifier of the reservation. Need to fill this in if this is an edited reservation. Leave it blank if this is a new reservation | |
| confPasscode | string | Passcode for participants to enter conference | |
| chairPasscode | string | Passcode for chairperson to enter conference | |
| templateName | string | Name of conference template this reservation is using. | Mandatory |
| sendEmail | boolean | Reservation confirmation will be sent to participants if set to TRUE | Mandatory |
| supportedLanguageEnum | SupportedLanguageEnum | The language used in the email notification message. | |
| dialInNumber | string | The dial in number of this reservation. This is a read-only field. Modification of this field is not allowed. For RMA-reservation, this is the VMR number | |
| entityTag | EntityTag | The unique value generated from the server object instance. This value is the same value that MUST 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. | |
| billingCode | string | The area billing code of this reservation. | |
| scheduleConferenceTypeEnum | ScheduleConferenceTypeEnum | Identify where the conference is reserved, when creating or updating reservation, only API_DMA_CONF and API_CMA_CONF are permitted. If not filled, API_DMA_CONF is set. | |
| bridgeSelectionTypeEnum | BridgeSelectionTypeEnum | Identify the bridge selection type, if not filled, MULTIDMAPOOL is set. CMA conference supports AUTOBRIDGE and SINGLEBRIDGE. DMA conference supports MULTIDMAPOOL. SINGLEDMAPOOL and MULTIDMAPOOL are not supported now. | |
| scheduledMcuIp | string | The ScheduledMcu's ip address of this reservation. If bridge-selection-type-enum is SINGLEBRIDGE, then scheduled-mcu-ip must be set. | |
| conferenceReserveTypeEnum | ConferenceReserveTypeEnum | Identify the conference reserve type, if not filled, SINGLE is set. If this is RECURRING, then plcm-sched-recurrence must be set. | |
| conferenceId | string | The conferenceId of reservation. | |
| vmrRoomId | string | The vmr room Id of reservation, Only used for DMA conference. | |
| recurrenceId | string | The recurrenceId of a set of reservations. It can identify the set of recurring reservations. This is a read-only field. | |
| startTime | dateTime | ||
| endTime | dateTime |
| Name | Type | Restrictions |
|---|---|---|
| ConferenceReserveTypeEnum | string | Value must be one of:
|
| BridgeSelectionTypeEnum | string | Value must be one of:
|
| ScheduleConferenceTypeEnum | string | Value must be one of:
|
| EntityTag | string | Length of value must be >=1 Length of value must be <=64 |
| SupportedLanguageEnum | string | Value must be one of:
|
| Name | string | Length of value must be >=1 Length of value must be <=64 |