Scheduling a Meeting
bookConf
API Description
This API is used to schedule a meeting.
Precautions
- The start time of a meeting must be later than the current time.
- The vmrId parameter must be passed for a personal meeting or cloud meeting room.
- The attendee parameter must be passed if participant information needs to be carried.
- Meeting recording must be enabled if automatic recording is enabled.
- For details about the meeting details returned in the callback, see HWMConfDetail.
Method Definition
1
|
- (void)bookConf:(HWMOrderConfParam *_Nonnull)param callback:(_Nonnull HWMSDKCompleteHandler)callback; |
Parameter Description
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
confSubject |
Yes |
NSString * |
Definition Meeting topic. Constraints N/A Range 0 to 128 characters. Default Value N/A |
startTimeStamp |
Yes |
NSTimeInterval |
Definition Meeting start time. The value is a UTC timestamp, accurate to seconds. Constraints The timestamp cannot be earlier than the current system time. Range N/A Default Value N/A |
duration |
No |
NSUInteger |
Definition Meeting duration, in minutes. Constraints N/A Range 15 minutes to 1,440 minutes. Default Value 30 minutes. |
isAutoRecord |
No |
BOOL |
Definition Whether to enable automatic meeting recording. Constraints Valid only for cloud recording, not for local recording on clients. Meeting recording must be enabled if automatic recording is enabled. Default Value NO: disabled. |
isRecordOn |
No |
BOOL |
Definition Whether to enable meeting recording. Constraints Valid only for cloud recording, not for local recording on clients. Default Value NO: disabled. |
timeZone |
Yes |
NSUInteger |
Definition Time zone. Constraints N/A Range 1 to 73. For details, see Time Zone Table. Default Value Current time zone. The default time zone of China is 56 (GMT+08:00). |
vmrId |
No |
NSString * |
Definition ID of the personal meeting or cloud meeting room. Constraints Required when the personal meeting is created or a cloud meeting room is used. In other cases, leave this parameter blank. Range 0 to 128 characters. Default Value N/A |
callInRestrictionType |
No |
Definition Users who can join the meeting. Constraints N/A Default Value HWMJoinConfRestrictionAll: everyone. |
|
attendee |
No |
NSArray<HWMAttendeeInfo *> * |
Definition Participant list (optional). Constraints N/A Default Value N/A |
isSmsOn |
No |
BOOL |
Definition Whether to send an SMS notification. Constraints Reserved field. SMS notification is not yet available. Default Value NO |
isMailOn |
No |
BOOL |
Definition (Optional) Whether to send email notifications. Constraints To use this function, enable it in the enterprise configuration. Otherwise, this parameter does not take effect. Default Value NO |
isEmailCalenderOn |
No |
BOOL |
Definition Whether to send a calendar email. Constraints To use this function, enable it in the enterprise configuration. Otherwise, this parameter does not take effect. Default Value NO |
noPassword |
No |
BOOL |
Definition Whether the meeting is password-free. Constraints Valid only for meetings with a random ID. Default Value NO: A password is required. |
guestPwd |
No |
NSString |
Definition Guest password. Constraints If this parameter is left blank, the server randomly generates a value. Valid only for meetings with a random ID. Range 0 to 64 characters. Default Value N/A |
isVideo |
No |
BOOL |
Definition Whether to schedule a video meeting. Constraints N/A Default Value YES |
vmrConfIdType |
No |
Definition ID type of the cloud meeting room. Constraints N/A Default Value HWMVmrConfIdTypeFixed: fixed. |
|
allowGuestStartConf |
No |
BOOL |
Definition Whether to allow guests to join the meeting ahead of the host. Constraints
Default Value YES |
allowGuestStartConfTime |
No |
NSUInteger |
Definition Time range allowed for guests to join the meeting in advance, in minutes. Constraints
Range
Default Value 0 |
isOpenWaitingRoom |
No |
BOOL |
Definition Whether to enable the waiting room. Constraints Takes effect only after the waiting room function is enabled. Default Value NO: disabled. |
customInfo |
No |
NSString * |
Definition User-defined information (meeting details and in-meeting chat messages). Constraints N/A Range 0 to 64 characters. Default Value N/A |
concurrentParticipants |
No |
NSUInteger |
Definition Maximum number of participants in the meeting. Constraints N/A Range
Default Value If this parameter is left blank, there is no restriction. |
confResType |
No |
Definition Meeting resource type. Constraints N/A Default Value HWMSDKConfRestypeDefault: default type. |
|
autoMuteMode |
No |
Definition Whether to automatically mute soft client guests when they join the meeting. Constraints N/A Default Value HWMSDKAutoMuteTypeDefault: same as the default configuration. |
|
hardTerminalAutoMuteMode |
No |
Definition Whether to automatically mute hard terminal guests when they join the meeting. Constraints N/A Default Value HWMSDKAutoMuteTypeDefault: same as the default configuration. |
|
defaultSummaryState |
No |
Definition Initial state of whether cloud recording contains minutes. Constraints Valid only when meeting minutes are supported. Default Value HWMSDKSummaryStateClose: disabled. |
|
autoPublishSummary |
No |
BOOL |
Definition Whether to automatically release minutes (without manual review). Constraints N/A Default Value NO: Minutes are not automatically released. |
attendeesExcludeSelf |
No |
BOOL |
Definition Whether the scheduler is excluded from the participant list. Constraints N/A Default Value NO: The scheduler is included. |
Parameter |
Value |
Description |
---|---|---|
HWMJoinConfRestrictionAll |
0 |
Everyone. |
HWMJoinConfRestrictionCompany |
2 |
Corporate users only. |
HWMJoinConfRestrictionInvited |
3 |
Invited users only. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
number |
No |
NSString * |
Definition Number. Constraints 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. Range 0 to 128 characters. Default Value N/A |
thirdUserId |
No |
NSString * |
Definition Third-party user ID. Constraints For app ID authentication. Either this parameter or number must be set. Range 0 to 128 characters. Default Value N/A |
name |
No |
NSString * |
Definition Participant name. Constraints N/A Range 0 to 256 characters. Default Value N/A |
|
No |
NSString * |
Definition Email address used for receiving email notifications. Constraints N/A Range 0 to 256 characters. Default Value N/A |
sms |
No |
NSString * |
Definition Mobile number used for receiving SMS notifications. Constraints N/A Range 0 to 128 characters. Default Value N/A |
role |
No |
Definition Participant role. Constraints N/A Default Value HWMConfRoleTypeAttendee: guest. |
|
accountId |
No |
NSString * |
Definition User UUID. Constraints N/A Range 0 to 128 characters. Default Value N/A |
mute |
No |
BOOL |
Definition Whether to mute the microphone. Constraints N/A Default Value NO: unmuted. |
isAnonymous |
No |
BOOL |
Definition Whether to join the meeting anonymously. (This parameter is used only for obtaining the participant list.) |
state |
No |
Definition Participant status. (This parameter is used only for obtaining the participant list.) |
|
orgId |
No |
NSString * |
Definition Used to identify whether the participant belongs to the current enterprise. (This parameter is used only for obtaining the participant list.) |
Parameter |
Description |
---|---|
HWMConfRoleTypeAttendee |
Guest. |
HWMConfRoleTypeChairman |
Host. |
Enumerated Value |
Description |
---|---|
HWMVmrConfIdTypeFixed |
Fixed. |
HWMVmrConfIdTypeRandom |
Random. |
Sample Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
/// Schedule a meeting. - (void)bookConf { HWMOrderConfParam * param = [[HWMOrderConfParam alloc] init]; param.confSubject = @"Meeting topic"; param.startTime = 1598759580; param.duration = 15; param.isAutoRecord = NO; param.timeZone = 56; param.vmrId = @""; param.attendee = self.attenteeArr; param.callInRestrictionType = HWMCallRestrictionAll; [[HWMBizSdk getBizOpenApi] bookConf:param callback:^(NSError *_Nullable error, id _Nullable result) { if (error) { NSLog(@"Schedule meeting failed.:%@", error.localizedDescription); } else { NSLog(@"Meeting scheduled."); } }]; } |
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