Help Center/ Meeting/ Client SDK Reference/ macOS SDK/ APIs/ Meeting Control/ Creating a Meeting

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

View PDF

Creating a Meeting

createConf

API Description

This API is used to create an instant meeting.

Precautions

By default, this API enables you to join a meeting as a host. During API calling, there is no need to add your information to the participant parameters.
If other participants need to be invited, their information needs to be transferred.
The meeting creation result can be obtained by calling the callback API.

Method Definition

    
         - (void)createConf:(HWMCreateConfParam * _Nonnull)param callback:( _Nonnull HWMSDKCreateConfCompleteHandler)callback;

Parameter Description

**Table 1** HWMCreateConfParam description
Parameter	Mandatory	Type	Description
subject	Yes	NSString *	Definition Meeting topic. Constraints N/A Range 0 to 128 characters. Default Value N/A
members	No	NSArray <HWMAttendeeInfo>	Definition Participant list (optional). Constraints N/A Default Value N/A
isCameraOn	No	BOOL	Definition Whether to enable the camera. Constraints N/A Default Value NO: disabled.
isMicOn	No	BOOL	Definition Whether to enable the microphone. Constraints N/A Default Value YES: enabled.
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.
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	HWMJoinConfRestrictionType	Definition Users who can join the meeting. Constraints N/A Default Value HWMJoinConfRestrictionAll: everyone.
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 create a video meeting. Constraints N/A Default Value YES
vmrConfIdType	No	HWMVmrConfIdType	Definition ID type of the cloud meeting room. Constraints N/A Default Value HWMVmrConfIdTypeFixed: fixed.
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 0: unlimited. > 0 Default Value If this parameter is left blank, there is no restriction.
confResType	No	HWMConfResType	Definition Meeting resource type. Constraints N/A Default Value HWMSDKConfRestypeDefault: default type.
autoMuteMode	No	HWMAutoMuteType	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	HWMAutoMuteType	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	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 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.

**Table 2** HWMAttendeeInfo description
Parameter	Mandatory	Type	Description
name	Yes	NSString	Definition Participant name. Constraints N/A Range 0 to 256 characters. Default Value N/A
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
accountId	No	NSString	Definition Login account. Constraints Mandatory for account and password login. Range 0 to 128 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
mute	No	BOOL	Definition Whether to mute the microphone. Constraints N/A Default Value NO: unmuted.
role	No	HWMConfRoleType	Definition Participant role. Constraints N/A Default Value HWMConfRoleTypeAttendee: guest.
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.)

**Table 3** Enumerated values of HWMConfResType
Enumerated Value	Description
HWMSDKConfRestypeDefault	Default.
HWMSDKConfRestypeShareVmr	Shared cloud meeting room.

**Table 4** Enumerated values of HWMAutoMuteType
Enumerated Value	Description
HWMSDKAutoMuteTypeDefault	Default.
HWMSDKAutoMuteTypeMute	Mute.
HWMSDKAutoMuteTypeUnmute	Unmute.

**Table 5** Enumerated values of HWMSummaryState
Enumerated Value	Description
HWMSDKSummaryStateClose	Disabled.
HWMSDKSummaryStateOpen	Enabled.

Return Values

None

Sample Code

     
          /// Create a meeting.
- (void)creatMeeting {
    HWMCreateConfParam *param = [[HWMCreateConfParam alloc] init];
    param.subject = @"Meeting topic";
    param.isCameraOn = YES; // Whether to turn on the camera. By default, the camera is turned off.
    param.isMicOn = YES; // Whether to turn on the microphone. By default, the microphone is turned on.
    param.isAutoRecord = NO;// Whether to enable the automatic recording function. By default, this function is disabled.
    param.joinConfRestrictionType = HWMJoinConfRestrictionAll;// Users who are allowed to join the meeting.

    [[HWMSdk getOpenApi] createConf:param callback:^(NSError * _Nullable error, HWMCreateConfResult * _Nullable result) {
        [self hideLoading];
        if (error) {
            NSLog(@"Create meeting failed.%@", error.localizedDescription);
        }else{
            NSLog(@"Meeting created.");
        }
    }];
}