文档首页/ 华为云会议 Meeting/ 客户端SDK参考/ HarmonyOS SDK/ 接口参考/ 会议控制/ 创建会议

更新时间：2025-01-09 GMT+08:00

查看PDF

创建会议

createConf

接口描述

该接口用于创建即时会议。

注意事项

该接口默认已将自己作为主持人加入会议，调用接口时，在与会者参数中不需要带上自己的信息。
若需要在创建会议的同时邀请其他与会者，需要传入其他与会者信息。若不需要，与会者信息和与会者个数可以为空。

方法定义

    
         creatConf(createConfParam: HWMOpenCreateConfParamModel): Promise<HWMCreateConfResult>;

参数描述

参数	是否必须	类型	描述
createConfParam	是	HWMOpenCreateConfParamModel	创建会议参数。

表1 HWMOpenCreateConfParamModel参数说明
参数	是否必须	类型	描述
confCommonParam	是	HWMOpenConfCommonParamModel	会议基本信息。
device	否	HWMOpenConfDeviceConfigModel	设备配置信息。
openCustomPara	否	string	自定义扩展信息。

表2 HWMOpenConfCommonParamModel参数说明
参数	是否必须	类型	描述
vmrId	否	string	云会议室唯一ID。预约随机会议时，设置为空字符串。
vmrIdType	否	VmrIdType	Vmr会议ID类型
confMediaType	是	ConfMediaType	会议媒体类型，仅支持视频会议。
subject	是	string	会议主题。
attendees	是	Array<HWMOpenAttendeeBaseInfoModel>	与会者信息。若不需要带与会者，参数值可以为空数组。
promptLanguage	否	ConfPromptLanguageType	语言。
recordMode	否	ConfRecordMode	会议录制模式。
isGuestJoinConfWithoutPwd	否	boolean	普通与会者是否可以无密码加入会议。说明：仅对随机会议ID生效
guestPwd	否	string	普通与会者密码，如果空则服务器随机生成。说明：仅对随机会议ID生效
confAllowJoinUser	否	ConfAllowJoinUserType	允许入会范围限制。默认所有用户。
isSendSms	否	boolean	发送短信通知开关，可选参数，企业配置里面需要开启，否则不生效。仅对预约会议、编辑会议生效。
isSendEmail	否	boolean	发送邮件通知开发，可选参数，企业配置里面需要开启，否则不生效。仅对预约会议、编辑会议生效。
concurrentParticipants	否	number	会议方数，会议最大与会人数限制。注：不填则不限制
confResType	否	ConfResType	会议资源类型。
autoMuteMode	否	AutoMuteType	来宾入会，软终端是否自动静音。
hardTerminalAutoMuteMode	否	AutoMuteType	来宾入会，硬终端是否自动静音。
supportWatermark	否	boolean	会议是否支持水印。

表3 枚举VmrIdType说明
枚举值	描述
HWM_FIXED_ID	VmrId是固定类型。
HWM_RANDOM_ID	VmrId是随机类型。

表4 枚举ConfMediaType说明
枚举值	描述
HWM_CONF_MEDIA_VIDEO	视频会议。

表5 HWMOpenAttendeeBaseInfoModel参数说明
参数	是否必须	类型	描述
name	是	string	会场名称。
number	否	string	号码。如果填分配给账号的sip号码（如+99111244216210249）则呼叫该账号的App；如果填PSTN号码（如18700000000），则通过VoIP网关呼叫该号码，前提是该企业已开通PSTN呼叫权限。与thirdUserId二选一，账号密码鉴权时使用。
thirdAccount	否	string	第三方用户账号。
isSelf	否	boolean	是否是自己。
isMute	否	boolean	是否静音。
accountId	否	string	用户登录账号。
email	否	string	邮箱地址。
sms	否	string	手机电话。
userUuid	否	string	用户UUID。

表6 枚举ConfPromptLanguageType说明
枚举值	描述
HWM_CONF_PROMPT_LANGUAGE_ZH_CN	简体中文。
HWM_CONF_PROMPT_LANGUAGE_EN_US	美国英文。

表7 枚举ConfRecordMode说明
枚举值	描述
HWM_CONF_RECORD_DISABLE	禁止录制。
HWM_CONF_RECORD_LIVE	直播模式。
HWM_CONF_RECORD_RECORD	录播模式。
HWM_CONF_RECORD_LIVE_AND_RECORD	直播 + 录播模式。

表8 枚举ConfAllowJoinUserType说明
枚举值	描述
HWM_CONF_ALLOW_JOIN_ANYONE	任何人。
HWM_CONF_ALLOW_JOIN_LOGINED_USER	已登录用户。
HWM_CONF_ALLOW_JOIN_IN_COMPANY_USER	企业内用户。
HWM_CONF_ALLOW_JOIN_INVITED_USER	被邀请用户。

表9 枚举ConfResType说明
枚举值	描述
HWM_CONF_RESTYPE_DEFAULT	默认。
HWM_CONF_RESTYPE_SHARE_VMR	共享vmr。

**表10** 枚举AutoMuteType说明
枚举值	描述
HWM_AUTO_MUTE_TYPE_DEFAULT	与默认配置一致。
HWM_AUTO_MUTE_TYPE_MUTE	静音。
HWM_AUTO_MUTE_TYPE_UNMUTE	非静音。

**表11** HWMOpenConfDeviceConfigModel参数说明
参数	是否必须	类型	描述
isMicOn	否	boolean	是否开启麦克风。
isSpkOn	否	boolean	是否开启扬声器。
isCamOn	否	boolean	是否开启摄像头。

返回值

**表12** HWMCreateConfResult参数说明
参数	类型	描述
result	SDKERR	接口调用结果，HWM_SDKERR_SUCCESS表示成功，详细请参考错误码参考。
reasonDesc	string	错误描述。
createConfResult	HWMCreateConfResultModel	创建会议结果信息

**表13** HWMCreateConfResultModel参数说明
参数	类型	描述
confId	string	会议ID。
vmrConfId	string	vmr会议ID。
hostPwd	string	主持人密码。
guestPwd	string	来宾密码。
guestJoinUri	string	来宾链接。
confRole	ConfRole	本人在会议中的角色。
confSubject	string	会议主题。
startTimeStamp	number	会议开始时间(时间戳，单位秒)。
endTimeStamp	number	会议结束时间(时间戳，单位秒)。
schedUserName	string	预约者名字。
isP2PConf	boolean	是否立即会议。
concurrentParticipants	number	会议方数，会议最大与会人数限制. 0: 无限制, 大于0: 会议最大与会人数。

**表14** 枚举ConfRole说明
枚举值	描述
HWM_ROLE_ATTENDEE	普通与会者。
HWM_ROLE_HOST	会议主持人。
HWM_ROLE_AUDIENCE	观众
HWM_ROLE_COHOST	联席主持人
HWM_ROLE_WAITING	等候室成员

示例代码

    
     
       
       
         /**
* 创建会议
*/
handleCreateConf() {
   const confCommonParam: HWMOpenConfCommonParamModel = {
      confMediaType: ConfMediaType.HWM_CONF_MEDIA_VIDEO,
      subject: this.subject,
      attendees: [],
      recordMode: this.getRecordMode,
      confAllowJoinUser: this.confAllowJoinUser,
      supportWatermark: this.isWatermarkOn,
      isGuestJoinConfWithoutPwd: this.isGuestJoinConfWithoutPwd,
      guestPwd: this.guestPwd
    }

    const confDeviceConfigModel: HWMConfDeviceConfigModel = {
      isMicOn: this.isMicOn,
      isSpkOn: this.isSpkOn,
      isCamOn: this.isCamOn
    }

    const createConfParam: HWMOpenCreateConfParamModel = {
      confCommonParam: confCommonParam,
      device: confDeviceConfigModel,
    }

    UISDK.getConfCtrlApi().creatConf(createConfParam).then((res: HWMCreateConfResult) => {
      const message: string = res.result === SDKERR.HWM_SDKERR_SUCCESS ? '创建会议成功' : '创建会议失败' + res.result;
      console.log(message);
    })
}

        

      

    
   

父主题： 会议控制

上一篇：会议控制

下一篇：加入会议

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

创建会议

createConf

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线