创建会议
createConf
接口描述
该接口用于创建即时会议。
注意事项
- 该接口默认已将自己作为主持人加入会议,调用接口时,在与会者参数中不需要带上自己的信息。
- 若需要在创建会议的同时邀请其他与会者,需要传入其他与会者信息。若不需要,与会者信息和与会者个数可以为空。
方法定义
1
|
creatConf(createConfParam: HWMOpenCreateConfParamModel): Promise<HWMCreateConfResult>; |
参数描述
参数 |
是否必须 |
类型 |
描述 |
---|---|---|---|
createConfParam |
是 |
创建会议参数。 |
参数 |
是否必须 |
类型 |
描述 |
---|---|---|---|
confCommonParam |
是 |
参数解释: 会议基本信息。 |
|
device |
否 |
参数解释: 设备配置信息。 |
|
openCustomPara |
否 |
string |
参数解释: 自定义扩展信息 约束限制: 不涉及 取值范围: 0-64个字符 默认取值: 不涉及 |
参数 |
是否必须 |
类型 |
描述 |
---|---|---|---|
vmrId |
否 |
string |
参数解释: 云会议室唯一ID。 约束限制: 预约随机会议时,设置为空字符串。 取值范围: 1-128个字符 默认取值: 不涉及 |
vmrIdType |
否 |
参数解释: 云会议室的会议ID类型 约束限制: 不涉及 默认取值: HWM_FIXED_ID 固定类型 |
|
confMediaType |
是 |
参数解释: 会议媒体类型。 约束限制: 仅支持视频会议,填HWM_CONF_MEDIA_VIDEO 默认取值: 不涉及 |
|
subject |
是 |
string |
参数解释: 会议主题。 约束限制: 不涉及 取值范围: 1-385个字符 默认取值: 不涉及 |
attendees |
是 |
Array<HWMOpenAttendeeBaseInfoModel> |
参数解释: 与会者信息。 约束限制: 若不需要带与会者,参数值可以为空数组。 默认取值: 不涉及 |
promptLanguage |
否 |
参数解释: 语言。 约束限制: 不涉及 默认取值: HWM_CONF_PROMPT_LANGUAGE_ZH_CN 简体中文 |
|
recordMode |
否 |
参数解释: 会议录制模式。 约束限制: 不涉及 默认取值: HWM_CONF_RECORD_DISABLE 禁止录制 |
|
isGuestJoinConfWithoutPwd |
否 |
boolean |
参数解释: 普通与会者是否可以无密码加入会议。 约束限制: 仅对随机会议ID生效 默认取值: false 即需要密码 |
guestPwd |
否 |
string |
参数解释: 普通与会者密码。 约束限制:
取值范围: 0-64个字符 默认取值: 不涉及 |
confAllowJoinUser |
否 |
参数解释: 允许入会范围限制。 约束限制: 不涉及 默认取值: HWM_CONF_ALLOW_JOIN_ANYONE 所有用户。 |
|
isSendSms |
否 |
boolean |
参数解释: 发送短信通知开关。 约束限制: 保留字段,暂不提供短信通知能力 默认取值: false 不开启短信通知能力。 |
isSendEmail |
否 |
boolean |
参数解释: 发送邮件通知开关。 约束限制:
默认取值: false 不发送邮件通知。 |
concurrentParticipants |
否 |
number |
参数解释: 会议方数,会议最大与会人数限制。 约束限制: 不涉及 取值范围:
默认取值: 不限制 |
confResType |
否 |
参数解释: 会议资源类型。 约束限制: 不涉及 默认取值: HWM_CONF_RESTYPE_DEFAULT 默认枚举值 |
|
autoMuteMode |
否 |
参数解释: 来宾入会,软终端是否自动静音。 约束限制: 不涉及 默认取值: HWM_AUTO_MUTE_TYPE_DEFAULT 默认配置 |
|
hardTerminalAutoMuteMode |
否 |
参数解释: 来宾入会,硬终端是否自动静音。 约束限制: 不涉及 默认取值: HWM_AUTO_MUTE_TYPE_DEFAULT 默认配置 |
|
supportWatermark |
否 |
boolean |
参数解释: 会议是否支持水印。 约束限制: 不涉及 默认取值: false 不支持。 |
defaultSummaryState |
否 |
参数解释: 会议云录制是否包含纪要,初始值。 约束限制: 仅企业配置支持智能会议纪要时生效(corpEnableSummary),参考HWMOpenCorpConfigParamModel参数说明 默认取值: HWM_SUMMARY_STATE_CLOSE 会议纪要关闭 |
|
autoPublishSummary |
否 |
bool |
参数解释: 是否自动发布纪要(免人工审核)。 约束限制: 不涉及 默认取值: 不自动发布纪要 |
参数 |
是否必须 |
类型 |
描述 |
---|---|---|---|
name |
是 |
string |
参数解释: 与会者名称。 约束限制: 不涉及 取值范围: 0-256个字符 默认取值: 不涉及 |
number |
否 |
string |
参数解释: 号码。 约束限制:
取值范围: 0-128个字符 默认取值: 不涉及 |
thirdAccount |
否 |
string |
参数解释: 第三方用户ID。 约束限制: 与number二选一,App ID鉴权时使用。 取值范围: 0-128个字符 默认取值: 不涉及 |
isSelf |
否 |
boolean |
参数解释: 是否是自己。 约束限制: 不涉及 默认取值: false 不是自己。 |
isMute |
否 |
boolean |
参数解释: 是否静音。 约束限制: 不涉及 默认取值: false 不静音。 |
accountId |
否 |
string |
参数解释: 用户登录账号。 约束限制: 不涉及 取值范围: 0-128个字符 默认取值: 不涉及 |
|
否 |
string |
参数解释: 邮箱地址。 约束限制: 不涉及 取值范围: 0-96个字符 默认取值: 不涉及 |
sms |
否 |
string |
参数解释: 短信通知手机号码。 约束限制: 不涉及 取值范围: 0-128个字符 默认取值: 不涉及 |
userUuid |
否 |
string |
参数解释: 用户UUID。 约束限制: 不涉及 取值范围: 0-128个字符 默认取值: 不涉及 |
corpId |
否 |
string |
参数解释: 企业id。 约束限制: 不涉及 取值范围: 0-32个字符 默认取值: 不涉及 |
枚举值 |
描述 |
---|---|
HWM_CONF_PROMPT_LANGUAGE_ZH_CN |
简体中文。 |
HWM_CONF_PROMPT_LANGUAGE_EN_US |
美国英文。 |
枚举值 |
描述 |
---|---|
HWM_CONF_RECORD_DISABLE |
禁止录制。 |
HWM_CONF_RECORD_LIVE |
直播模式。 |
HWM_CONF_RECORD_RECORD |
录播模式。 |
HWM_CONF_RECORD_LIVE_AND_RECORD |
直播 + 录播模式。 |
枚举值 |
描述 |
---|---|
HWM_CONF_ALLOW_JOIN_ANYONE |
任何人。 |
HWM_CONF_ALLOW_JOIN_LOGINED_USER |
已登录用户。 |
HWM_CONF_ALLOW_JOIN_IN_COMPANY_USER |
企业内用户。 |
HWM_CONF_ALLOW_JOIN_INVITED_USER |
被邀请用户。 |
枚举值 |
描述 |
---|---|
HWM_AUTO_MUTE_TYPE_DEFAULT |
与默认配置一致。 |
HWM_AUTO_MUTE_TYPE_MUTE |
静音。 |
HWM_AUTO_MUTE_TYPE_UNMUTE |
非静音。 |
参数 |
是否必须 |
类型 |
描述 |
---|---|---|---|
isMicOn |
否 |
boolean |
参数解释: 是否开启麦克风。 约束限制: 不涉及 默认取值: false 不开启麦克风。 |
isSpeakerOff |
否 |
boolean |
参数解释: 移动端:true-打开听筒,false-打开扬声器; PC端:true-关闭扬声器,false-打开扬声器。 约束限制: 不涉及 默认取值: fals。 |
isCamOn |
否 |
boolean |
参数解释: 是否开启摄像头。 约束限制: 不涉及 默认取值: false 不开启摄像头。 |
返回值
参数 |
类型 |
描述 |
---|---|---|
result |
SDKERR |
接口调用结果,HWM_SDKERR_SUCCESS表示成功,详细请参考错误码参考。 |
reasonDesc |
string |
错误描述。 |
createConfResult |
创建会议结果信息 |
参数 |
类型 |
描述 |
---|---|---|
confId |
string |
会议ID。 |
vmrConfId |
string |
vmr会议ID。 |
hostPwd |
string |
主持人密码。 |
guestPwd |
string |
来宾密码。 |
guestJoinUri |
string |
来宾链接。 |
confRole |
本人在会议中的角色。 |
|
confSubject |
string |
会议主题。 |
startTimeStamp |
number |
会议开始时间(时间戳,单位秒)。 |
endTimeStamp |
number |
会议结束时间(时间戳,单位秒)。 |
schedUserName |
string |
预约者名字。 |
isP2PConf |
boolean |
是否立即会议。 |
concurrentParticipants |
number |
会议方数,会议最大与会人数限制. 0: 无限制, 大于0: 会议最大与会人数。 |
枚举值 |
描述 |
---|---|
HWM_ROLE_ATTENDEE |
普通与会者。 |
HWM_ROLE_HOST |
会议主持人。 |
HWM_ROLE_AUDIENCE |
观众 |
HWM_ROLE_COHOST |
联席主持人 |
HWM_ROLE_WAITING |
等候室成员 |
示例代码
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
/** * 创建会议 */ 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); }) } |