Scheduling a Meeting
Function
This API is used to schedule a meeting. 1. Call this API only after login. 2. When calling this API, add yourself as the host to the participant list. 3. The callback function returns details about the scheduled meeting. For details, see the HwmConfDetail structure. If only a meeting ID is returned, meeting details fail to be obtained.
Function Prototype
bookConf(bookConfParam: BookConfParam, onBookConfResult?: (ret: SDKERR, reason: string, confDetail: ConfDetail) => void): voidbookConf(bookConfParam: BookConfParam, onBookConfResult?: (ret: SDKERR, reason: string, confDetail: ConfDetail) => void): void
Request Parameters
Parameter | Mandatory | Type | Description |
---|---|---|---|
bookConfParam | Yes | BookConfParam | Parameters for scheduling a meeting. |
onBookConfResult | Yes | (ret: SDKERR, reason: string, confDetail: ConfDetail) => void | Callback of scheduling the meeting. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
startTime | Yes | number | UTC timestamp when the meeting starts, in seconds. |
duration | Yes | number | Meeting duration, in minutes. The value ranges from 15 to 1,440. |
confCommonParam | Yes | ConfCommonParam | Common meeting parameters. |
isSendCalendar | No | boolean | Whether to send a calendar email. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
subject | Yes | string | Meeting topic. |
mediaType | No | MediaType | Meeting type. By default, the meeting is an audio meeting. |
needPassword | No | boolean | Whether a guest password is required. By default, the guest password is not required (valid only for meetings with a random ID). |
isAutoRecord | No | boolean | Whether to enable automatic meeting recording. By default, this function is disabled. If automatic meeting recording is enabled, the meeting will be recorded by default, regardless of whether recording is enabled or disabled in the meeting. This parameter is valid only for cloud recording, not for local recording on clients. |
allowRecord | No | boolean | Whether meeting recording is supported. (This parameter is valid only for the Windows platform.) This parameter is valid only for cloud recording, not for local recording on clients. |
allowLive | No | boolean | Reserved field. This parameter is transparently transmitted during meeting modification. |
timezone | Yes | Timezone | Time zone code. This parameter is used for sending meeting notifications. |
vmrId | No | string | Unique cloud meeting room ID. To schedule a meeting using concurrent participants, set this parameter to an empty string. When you modify a meeting, you cannot modify this parameter and need to enter the value returned in meeting details. |
confAllowJoinUser | No | ConfAllowJoinUserType | Users who are allowed to join the meeting. By default, everyone is allowed. |
isSendSms | No | boolean | Whether to send an SMS notification. To use this function, enable it in the enterprise configuration first. Otherwise, this parameter does not take effect. |
isSendEmail | No | boolean | Whether to send an email notification. |
vmrConfIdType | No | VmrConfIdType | ID type of the cloud meeting room. When modifying a meeting, set this parameter to HWM_VMR_CONF_ID_TYPE_FIXED if vmrConfId in meeting details is not empty, or set it to HWM_VMR_CONF_ID_TYPE_RANDOM if vmrConfId in meeting details is empty. |
guestPwd | No | string | Guest password. If this parameter is left empty, the server randomly generates a password. This parameter is valid only for meetings with a random ID. |
isOpenWaitingRoom | No | boolean | Waiting room status. This parameter takes effect only when the waiting room function is enabled. |
numOfAttendee | Yes | number | Number of participants. |
attendees | Yes | AttendeeBaseInfo | Participant list. |
allowGuestStartConf | No | boolean | Whether to allow guests to start the meeting. |
allowGuestStartConfTime | No | number | Time range for a guest to join the meeting in advance, in minutes. 0: at any time; n: n minutes in advance. |
concurrentParticipants | Yes | number | Maximum number of participants in the meeting. The value can be 0 (unlimited) or greater than 0 (specific maximum number of participants). |
customInfo | No | string | User-defined information. |
confResType | No | ConfResType | Meeting resource type. |
defaultSummaryState | No | SummaryState | Initial state of whether the cloud recording contains minutes (unavailable for recurring meetings; valid only for the Windows platform). |
autoMuteMode | No | AutoMuteType | Whether soft client guests are automatically muted when they join the meeting. |
hardTerminalAutoMuteMode | No | AutoMuteType | Whether hard terminal guests are automatically muted when they join the meeting. |
Enumeration Name | Enumerated Value | Description |
---|---|---|
HWM_MEDIA_TYPE_AUDIO | 0 | Audio. |
HWM_MEDIA_TYPE_VIDEO | 1 | Video. |
Enumeration Name | Enumerated Value | Description |
---|---|---|
HWM_TIMEZONE_DEFAULT | 0 | Default MediaX time zone |
HWM_TIMEZONE_INTERDATE_LINE | 1 | International Date Line West |
HWM_TIMEZONE_MIDWAY_ISLAND | 2 | Midway Island, Samoa |
HWM_TIMEZONE_HAWAII | 3 | Hawaii |
HWM_TIMEZONE_ALASKA | 4 | Alaska |
HWM_TIMEZONE_PACIFIC_TIME | 5 | Pacific Time (US & Canada), Tijuana |
HWM_TIMEZONE_ARIZONA | 6 | Arizona |
HWM_TIMEZONE_MOUNTAIN_TIME | 7 | Mountain Time (US & Canada) |
HWM_TIMEZONE_CENTRAL_AMERICA | 8 | Central America |
HWM_TIMEZONE_CENTRAL_TIME | 9 | Central Time (US & Canada) |
HWM_TIMEZONE_MEXICO_CITY | 10 | Mexico City |
HWM_TIMEZONE_SASKATCHEWAN | 11 | Saskatchewan |
HWM_TIMEZONE_BOGOTA | 12 | Bogota, Lima, Quito |
HWM_TIMEZONE_EASTERN_TIME | 13 | Eastern Time (US & Canada) |
HWM_TIMEZONE_INDIANA | 14 | Indiana (East) |
HWM_TIMEZONE_ATLANTIC_TIME | 15 | Atlantic Time (Canada) |
HWM_TIMEZONE_CARACAS | 16 | Caracas, La Paz |
HWM_TIMEZONE_SANTIAGO | 17 | Santiago |
HWM_TIMEZONE_NEWFOUNDLAND | 18 | Newfoundland |
HWM_TIMEZONE_BRASILIA | 19 | Brasilia |
HWM_TIMEZONE_BUENOS_AIRES | 20 | Buenos Aires, Georgetown |
HWM_TIMEZONE_GREENLAND | 21 | Greenland |
HWM_TIMEZONE_MID_ATLANTIC | 22 | Mid-Atlantic |
HWM_TIMEZONE_AZORES | 23 | Azores |
HWM_TIMEZONE_CAPEVERDE | 24 | Cape Verde Is. |
HWM_TIMEZONE_MONROVIA | 25 | Monrovia |
HWM_TIMEZONE_GREENWICH_MEANTIME | 26 | Greenwich Mean Time: Dublin, Edinburgh, Lisbon, London |
HWM_TIMEZONE_AMSTERDAM | 27 | Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna |
HWM_TIMEZONE_BELGRADE | 28 | Belgrade, Bratislava, Budapest, Ljubljana, Prague |
HWM_TIMEZONE_BRUSSELS | 29 | Brussels, Copenhagen, Madrid, Paris |
HWM_TIMEZONE_SARAJEVO | 30 | Sarajevo, Skopje, Vilnius, Sofia, Warsaw, Zagreb |
HWM_TIMEZONE_WESTCENTRAL_AFRICA | 31 | West Central Africa |
HWM_TIMEZONE_ATHENS | 32 | Athens, Istanbul, Minsk |
HWM_TIMEZONE_BUCHAREST | 33 | Bucharest |
HWM_TIMEZONE_CAIRO | 34 | Cairo |
HWM_TIMEZONE_HARARE | 35 | Harare, Pretoria |
HWM_TIMEZONE_HELSINKI | 36 | Helsinki, Riga, Tallinn |
HWM_TIMEZONE_JERUSALEM | 37 | Jerusalem |
HWM_TIMEZONE_BAGHDAD | 38 | Baghdad |
HWM_TIMEZONE_KUWAIT | 39 | Kuwait, Riyadh |
HWM_TIMEZONE_MOSCOW | 40 | Moscow, St. Petersburg, Kazan, Volgograd |
HWM_TIMEZONE_NAIROBI | 41 | Nairobi |
HWM_TIMEZONE_TEHRAN | 42 | Tehran |
HWM_TIMEZONE_ABU_DHABI | 43 | Abu Dhabi, Muscat |
HWM_TIMEZONE_TBILISI | 44 | Tbilisi, Yerevan |
HWM_TIMEZONE_KABUL | 45 | Kabul |
HWM_TIMEZONE_EKATERINBURG | 46 | Ekaterinburg |
HWM_TIMEZONE_ISLAMABAD | 47 | Islamabad, Karachi, Tashkent |
HWM_TIMEZONE_CALCUTTA | 48 | Kolkata, Chennai, Mumbai, New Delhi |
HWM_TIMEZONE_KATHMANDU | 49 | Kathmandu |
HWM_TIMEZONE_ALMATY | 50 | Almaty |
HWM_TIMEZONE_ASTANA | 51 | Astana, Dhaka |
HWM_TIMEZONE_SRIJAYA | 52 | Sri Jayawardenepura |
HWM_TIMEZONE_RANGOON | 53 | Yangon (Rangoon) |
HWM_TIMEZONE_BANGKOK | 54 | Bangkok, Jakarta, Hanoi |
HWM_TIMEZONE_NOVOSIBIRSK | 55 | Novosibirsk |
HWM_TIMEZONE_BEIJING | 56 | Beijing, Chongqing, Hong Kong, Urumqi, Taipei |
HWM_TIMEZONE_KRASNOYARSK | 57 | Krasnoyarsk, Ulaanbaatar |
HWM_TIMEZONE_KUALA_LUMPUR | 58 | Kuala Lumpur, Singapore |
HWM_TIMEZONE_PERTH | 59 | Perth |
HWM_TIMEZONE_OSAKA | 60 | Tokyo, Osaka, Sapporo |
HWM_TIMEZONE_SEOUL | 61 | Seoul |
HWM_TIMEZONE_YAKUTSK | 62 | Yakutsk |
HWM_TIMEZONE_ADELAIDE | 63 | Adelaide |
HWM_TIMEZONE_DARWIN | 64 | Darwin |
HWM_TIMEZONE_BRISBANE | 65 | Brisbane |
HWM_TIMEZONE_CANBERRA | 66 | Canberra, Melbourne, Sydney |
HWM_TIMEZONE_GUAM | 67 | Guam, Port Moresby |
HWM_TIMEZONE_HOBART | 68 | Hobart |
HWM_TIMEZONE_VLADIVOSTOK | 69 | Vladivostok |
HWM_TIMEZONE_SOLOMON | 70 | Solomon Is., New Caledonia |
HWM_TIMEZONE_AUCKLAND | 71 | Auckland, Wellington |
HWM_TIMEZONE_FIJI | 72 | Fuji, Kamchatka, Marshall Is. |
HWM_TIMEZONE_NUKUALOFA | 73 | Nuku'alofa |
HWM_TIMEZONE_IRKUTSK | 74 | Irkutsk |
HWM_TIMEZONE_CASABLANCA | 75 | Casablanca |
HWM_TIMEZONE_BAKU | 76 | Baku |
HWM_TIMEZONE_MAGADAN | 77 | Magadan |
Enumeration Name | Enumerated Value | Description |
---|---|---|
CONF_ALLOW_JOIN_ANYONE | 0 | Everyone. |
CONF_ALLOW_JOIN_LOGINED_USER | 1 | Logged-in users. |
CONF_ALLOW_JOIN_IN_COMPANY_USER | 2 | Corporate users only. |
CONF_ALLOW_JOIN_INVITED_USER | 3 | Invited users only. |
Enumeration Name | Enumerated Value | Description |
---|---|---|
HWM_VMR_CONF_ID_TYPE_FIXED | 0 | Fixed ID of the cloud meeting room. |
HWM_VMR_CONF_ID_TYPE_RANDOM | 1 | Random ID of the cloud meeting room. |
Parameter | Mandatory | Type | Description |
---|---|---|---|
nickName | Yes | string | Participant name. |
number | Yes | string | Number. If this parameter is set to the SIP number (for example, +99111244216210249) allocated to the account, the Huawei Cloud Meeting app is called. If this parameter is set to a PSTN number (for example, 18700000000), the number is called through the VoIP gateway if the enterprise has enabled PSTN call. This parameter is used for account and password authentication. Either this parameter or thirdUserId must be set. |
thirdUserId | Yes | string | Third-party user ID. This parameter is used for app ID authentication. Either this parameter or number must be set. |
accountId | No | string | Huawei Cloud Meeting account. |
No | string | Email address used for receiving email notifications. | |
sms | No | string | Mobile number used for receiving SMS notifications. |
isAutoInvite | No | boolean | Whether participants are automatically invited. |
isMute | No | boolean | Whether the microphone is muted. |
role | No | ConfRole | Participant role in the meeting. |
type | No | AttendeeType | Participant type. |
userUuid | No | string | Participant UUID. |
Enumeration Name | Enumerated Value | Description |
---|---|---|
HWM_CONF_ROLE_ATTENDEE | 0 | Common participant. |
HWM_CONF_ROLE_HOST | 1 | Host. |
HWM_CONF_ROLE_AUDIENCE | 2 | Attendee. |
HWM_CONF_ROLE_COHOST | 3 | Co-host. |
HWM_CONF_ROLE_WAITING | 4 | Waiting room member. |
Enumeration Name | Enumerated Value | Description |
---|---|---|
ATTENDEE_TYPE_NORMAL | 0 | Voice, HD, and SD participant addresses. |
ATTENDEE_TYPE_TELEPRESENCE | 1 | Address of a telepresence participant (uni-screen or tri-screen telepresence participant). |
ATTENDEE_TYPE_TERMINAL | 2 | Meeting room or hard terminal. |
ATTENDEE_TYPE_OUTSIDE | 3 | External participant. |
ATTENDEE_TYPE_CUSTOMNUMBER | 4 | Custom number. |
ATTENDEE_TYPE_MOBILE | 5 | Soft client user's mobile phone. |
ATTENDEE_TYPE_ANONYMOUS | 6 | Anonymous user. |
ATTENDEE_TYPE_TELEPHONE | 7 | Phone user. |
ATTENDEE_TYPE_BOARD | 8 | Whiteboard user. |
ATTENDEE_TYPE_IDEAHUB | 9 | Large-screen device with HiSilicon chips. |
ATTENDEE_TYPE_HWVISION | 10 | Smart TV. |
ATTENDEE_TYPE_WELINKC | 11 | WeLink (public edition). |
Enumeration Name | Enumerated Value | Description |
---|---|---|
HWM_CONF_RESTYPE_DEFAULT | 0 | Default. |
HWM_CONF_RESTYPE_SHARE_VMR | 3 | Shared cloud meeting room. |
Enumeration Name | Enumerated Value | Description |
---|---|---|
SUMMARY_STATE_CLOSE | 0 | Disabled. |
SUMMARY_STATE_OPEN | 1 | Enabled. |
Enumeration Name | Enumerated Value | Description |
---|---|---|
AUTO_MUTE_TYPE_DEFAULT | 0 | Default. |
AUTO_MUTE_TYPE_MUTE | 1 | Muted. |
AUTO_MUTE_TYPE_UNMUTE | 2 | Unmuted. |
Return Values
void
Callback Method Parameters
(ret: SDKERR, reason: string, confDetail: ConfDetail) => void
Parameter | Type | Description |
---|---|---|
ret | For details about SDKERR, see Error Code Reference. | Error code. |
reason | string | Error description. |
confDetail | ConfDetail | Meeting details. |
Parameter | Type | Description |
---|---|---|
confListInfo | ConfListItem | Basic meeting information. |
vmrId | string | Unique cloud meeting room ID. |
vmrFlag | boolean | Whether the meeting is held in a cloud meeting room. |
isAutoRecord | boolean | Whether automatic meeting recording is enabled. |
allowRecord | boolean | Whether meeting recording is supported. |
allowLive | boolean | Reserved field. This parameter is transparently transmitted during meeting modification. |
needPassword | boolean | Whether a password is required. |
isSendSms | boolean | Whether SMS notifications are sent. |
isSendEmail | boolean | Whether email notifications are sent. |
isSendCalendar | boolean | Whether calendar notifications are sent. |
confAllowJoinUser | ConfAllowJoinUserType | Meeting access settings. |
numOfAttendee | number | Number of participants. |
attendees | AttendeeBaseInfo | Participant list. |
isOpenWaitingRoom | boolean | Whether the waiting room is enabled. |
allowGuestStartConf | boolean | Whether to allow guests to start the meeting. |
allowGuestStartConfTime | number | Time range for a guest to join the meeting in advance, in minutes. 0: at any time; n: n minutes in advance. |
vmrConfIdType | VmrConfIdType | ID type of the cloud meeting room. |
concurrentParticipants | number | Maximum number of participants in the meeting. The value can be 0 (unlimited) or greater than 0 (specific maximum number of participants). |
defaultSummaryState | SummaryState | Initial state of whether the cloud recording contains minutes (unavailable for recurring meetings; valid only for the Windows platform). |
autoMuteMode | AutoMuteType | Whether soft client users are automatically muted. |
hardTerminalAutoMuteMode | AutoMuteType | Whether hard terminal users are automatically muted. |
Parameter | Type | Description |
---|---|---|
confId | string | Meeting ID. |
subject | string | Meeting topic. |
hostPwd | string | Host password. |
guestPwd | string | Guest password. |
audiencePwd | string | Attendee password. (This parameter is valid only for the Windows platform.) |
startTime | number | UTC time when the meeting starts, in seconds. |
endTime | number | UTC time when the meeting ends, in seconds. |
timezone | Timezone | Time zone code (valid only for the Windows platform). |
mediaType | MediaType | Media type. |
schedulerName | string | Name of the user who schedules the meeting. |
vmrConfId | string | Display ID of the cloud meeting. |
hostJoinUri | string | Link for the host to join the meeting. |
guestJoinUri | string | Link for guests to join the meeting. |
audienceJoinUri | string | Link for attendees to join the meeting (valid only for the Windows platform). |
confStateType | ConfState | Meeting status (valid only for the Windows platform). |
isWebinar | boolean | Whether the meeting is a webinar or not (valid only for the Windows platform). |
selfConfRole | ConfRole | Role in the meeting. |
conferenceType | ConferenceType | Meeting type. |
cycleParam | CycleConfParam | Recurring meeting series parameters. |
subConfSize | number | Number of recurring meetings. |
subConfParam | SubCycleConfParam | Recurring meeting parameters. |
customInfo | string | User-defined information. |
Enumeration Name | Enumerated Value | Description |
---|---|---|
HWM_CONF_STATE_SCHEDULE | 0 | The meeting is scheduled. |
HWM_CONF_STATE_CREATING | 1 | The meeting is being created. |
HWM_CONF_STATE_GOING | 2 | The meeting has started. |
HWM_CONF_STATE_DESTROYED | 3 | The meeting has ended. |
Enumeration Name | Enumerated Value | Description |
---|---|---|
HWM_CONF_TYPE_COMMON | 0 | Common meeting. |
HWM_CONF_TYPE_CYCLE | 1 | Recurring meeting. |
Parameter | Type | Description |
---|---|---|
startDate | number | Start date and timestamp, accurate to seconds (GMT). |
endDate | number | End date and timestamp, accurate to seconds (GMT). |
cycleType | CycleType | Period type. |
interval | number | Interval of recurring meetings. If cycleType is set to daily, there is a meeting every several days and the value range is [1,15]. If cycleType is set to weekly, there is a meeting every several weeks and the value range is [1,5]. If cycleType is set to monthly, there is a meeting every several months and the value range is [1,3]. |
listPoints | string | Point for holding recurring meetings. This parameter is valid only when meetings are held weekly or monthly. Values are separated by colons (,), for example, 1,3,5,7. |
preRemindDays | number | Number of days in advance users are notified of a recurring meeting. |
Enumeration Name | Enumerated Value | Description |
---|---|---|
CYCLE_TYPE_DAY | 0 | Daily. |
CYCLE_TYPE_WEEK | 1 | Weekly. |
CYCLE_TYPE_MONTH | 2 | Monthly. |
Parameter | Type | Description |
---|---|---|
subConfID | string | UUID of a recurring meeting. |
mediaType | MediaType | Media type. |
startTime | number | Meeting start time. |
endTime | number | Meeting end time. |
isAutoRecord | boolean | Whether to automatically start recording after a meeting starts. |
recordAuthType | RecordAuthType | Recording authentication mode. |
confAllowJoinUser | ConfAllowJoinUserType | Users who are allowed to join the meeting. By default, everyone is allowed. |
allowGuestStartConf | boolean | Whether to allow guests to start the meeting. |
allowGuestStartConfTime | number | Time range for a guest to join the meeting in advance, in minutes. 0: at any time; n: n minutes in advance. |
Enumeration Name | Enumerated Value | Description |
---|---|---|
REOCRD_AUTH_TYPE_ANYONE | 0 | The recording can be viewed or downloaded through link (no nonce is added). |
REOCRD_AUTH_TYPE_IN_COMPANY_USER | 1 | Corporate users can view or download the recording. |
REOCRD_AUTH_TYPE_ATTENDEE | 2 | Participants can view or download the recording. |
Parameter | Type | Description |
---|---|---|
nickName | string | Participant name. |
number | string | Number. If this parameter is set to the SIP number (for example, +99111244216210249) allocated to the account, the Huawei Cloud Meeting app is called. If this parameter is set to a PSTN number (for example, 18700000000), the number is called through the VoIP gateway if the enterprise has enabled PSTN call. This parameter is used for account and password authentication. Either this parameter or thirdUserId must be set. |
thirdUserId | string | Third-party user ID. This parameter is used for app ID authentication. Either this parameter or number must be set. |
accountId | string | Huawei Cloud Meeting account. |
string | Email address used for receiving email notifications. | |
sms | string | Mobile number used for receiving SMS notifications. |
isAutoInvite | boolean | Whether participants are automatically invited. |
isMute | boolean | Whether the microphone is muted. |
role | ConfRole | Participant role in the meeting. |
type | AttendeeType | Participant type. |
userUuid | string | Participant UUID. |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot