Help Center/ Meeting/ Client SDK Reference/ iOS SDK/ APIs/ Meeting Management/ Scheduling a Meeting

Updated on 2025-07-28 GMT+08:00

View PDF

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

    
         - (void)bookConf:(HWMOrderConfParam *_Nonnull)param callback:(_Nonnull HWMSDKCompleteHandler)callback;

Parameter Description

**Table 1** HWMOrderConfParam description
Parameter	Mandatory	Type	Description
confSubject	Yes	NSString *	Definition Meeting topic. Constraints N/A Range 0 to 385 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. Default Value N/A
duration	No	NSUInteger	Definition Meeting duration, in minutes. Constraints N/A Range 15 to 1,440 minutes. Default Value 30 minutes.
confType	Yes	HWMOrderConfType	Definition Meeting type. Constraints N/A Default Value OrderConfTypeAudio: voice meeting.
isNeedConfPwd	No	BOOL	Definition Whether a guest password is required. Constraints Valid only for meetings with a random ID. Default Value NO: not required.
guestPwd	No	NSSting *	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
isRecordOn	No	BOOL	Definition Whether to enable meeting recording. This parameter will be deprecated and is not recommended. Constraints Valid only for cloud recording, not for local recording on clients. Default Value NO: disabled.
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.
timeZone	No	NSUInteger	Definition Time zone. Constraints N/A Range See Time Zone Table. Default Value 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
vmrIdType	No	HWMVmrIdType	Definition Type of the cloud meeting room ID (fixed/random). Constraints N/A Default Value HWMVmrIdType: fixed.
callInRestrictionType	No	HWMJoinConfRestrictionType	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
allowGuestStartConf	No	BOOL	Definition Whether to allow guests to join the meeting ahead of the host. Constraints Valid only for meetings with a random ID. For meetings with fixed IDs, use the API for Modifying Cloud Meeting Room Information. Default Value YES
allowGuestStartConfTime	No	NSInteger	Definition Time range allowed for guests to join the meeting in advance, in minutes. Constraints Valid only for meetings with a random ID. Unsupported for meetings with fixed IDs. Range 0: any time before the scheduled time. x: x minutes before the scheduled time. Default Value 0
isOpenWaitingRoom	No	BOOL	Definition Waiting room status. 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 N/A Default Value If this parameter is left blank, there is no restriction.
autoMuteMode	No	HWMAutoMuteType	Definition Whether to automatically mute personal client users when they join the meeting. Constraints N/A Default Value HWMAutoMuteTypeDefault: same as the default configuration.
hardTerminalAutoMuteMode	No	HWMAutoMuteType	Definition Whether to automatically mute meeting room device users when they join the meeting. Constraints N/A Default Value HWMAutoMuteTypeDefault: same as the default configuration.
confResType	No	HWMConfResType	Definition Meeting resource type. Constraints N/A Default Value HWMSDKConfRestypeDefault: default type.
defaultSummaryState	No	HWMSummaryState	Definition Initial state of whether cloud recording contains minutes. Constraints Valid only when the enterprise configuration supports smart meeting minutes (corpEnableSummary). For details, see Notifications of Enterprise Configuration Information. 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.

**Table 2** Enumerated values of HWMOrderConfType
Parameter	Description
OrderConfTypeAudio	Voice meeting.
OrderConfTypeVideo	Video meeting.

**Table 3** Enumerated values of HWMJoinConfRestrictionType
Parameter	Value	Description
HWMJoinConfRestrictionAll	0	Everyone.
HWMJoinConfRestrictionCompany	2	Corporate users only.
HWMJoinConfRestrictionInvited	3	Invited users only.

**Table 4** HWMAttendeeInfo description
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
email	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	ConfRoleType	Definition Participant role. Constraints N/A Default Value ConfRoleTypeAttendee: guest.
accountId	No	NSString *	Definition User UUID. Constraints N/A Range 0 to 128 characters. Default Value N/A
userUuid	No	NSString *	Definition This parameter can be obtained from the meeting details when you edit a meeting. By default, this parameter is left blank.
isAnonymous	No	BOOL	Definition Whether to join the meeting anonymously. (This parameter is used only for obtaining the participant list.)
state	No	HWMConfAttendeeState	Definition Participant status. (This parameter is used only for obtaining the participant list.)
orgId	No	NSString *	Definition Enterprise ID. Constraints N/A Range 0 to 32 characters. Default Value N/A

**Table 5** Enumerated values of ConfRoleType
Parameter	Description
ConfRoleTypeAttendee	Guest.
ConfRoleTypeChairman	Host.
ConfRoleTypeAudience	Attendee.
ConfRoleTypeCohost	Co-host.

**Table 6** Enumerated values of HWMVmrIdType
Parameter	Description
HWMVmrIdTypeFixed	Fixed type.
HWMVmrIdTypeRandom	Random type.

Sample Code

    
     
       
       
         /// Schedule a meeting.
- (void)bookConf {
    HWMOrderConfParam * param = [[HWMOrderConfParam alloc] init];
    param.confSubject = @"Meeting topic";
    param.startTimeStamp = 1598759580;
    param.duration = 15;
    param.confType = HWMConfTypeVideo;
    param.isNeedConfPwd = YES;
    param.isRecordOn = NO;
    param.timeZone = 56;
    param.vmrId = @"";
    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.");
        }
    }];
}

        

      

    
   