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

预约会议

bookConf

接口描述

该接口用于预约会议。

注意事项

  1. 该接口在已登录状态下才能调用。
  2. 会议开始时间需要晚于当前时间。
  3. 个人会议或者云会议室的时候要传入vmrId。
  4. 携带与会者入会的时候需要传入attendees。

方法定义

1
bookConf(bookConfParam: HWMOpenBookConfParamModel): Promise<HWMBookConfResult>;

参数描述

参数

是否必须

类型

描述

bookConfParam

HWMOpenBookConfParamModel

预约会议参数。

表1 HWMOpenBookConfParamModel参数说明

参数

是否必须

类型

描述

startTime

number

会议开始时间时间戳(utc时间),单位是秒。

说明:

UTC时间与UTC偏移量(转换为秒)的差值,如东八区为 UTC时间戳 - (8 * 60 * 60)

confLen

number

会议时长,单位分钟,最小值15分钟,最大值1440分钟。

confCommonParam

HWMOpenConfCommonParamModel

会议基本信息。

isSendCalendarNotify

boolean

发送邮件日历开关。

allowGuestStartConf

boolean

是否允许来宾提前启动会议。

说明:

allowGuestStartConfTime

number

允许来宾提前入会时间范围(单位:分钟):

0 - 随时

x - 提前x分钟启动会议

说明:
  • 仅针对随机会议ID的会议生效。
  • 固定会议ID的会议,不支持设置提前入会时间。

openCustomPara

string

自定义扩展信息。

返回值

表2 HWMBookConfResult参数说明

参数

类型

描述

result

SDKERR

接口调用结果,HWM_SDKERR_SUCCESS表示成功,详细请参考错误码参考

reasonDesc

string

错误描述。

bookConfResult

HWMCreateConfResultModel

预约会议结果信息。

示例代码

 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
32
33
34
35
36
/**
* 预约会议
*/
handleBookConf(){
    const attendees: Array<HWMOpenAttendeeBaseInfoModel> = [{
      number: this.getNumber(),
      name: this.getName(),
      accountId: this.getAccountId(),
      isSelf: this.isSelf,
      thirdAccount: this.getThirdAccount(),
      userUuid: this.getUserUuid()
    }];
    const confCommonParam: HWMOpenConfCommonParamModel = {
      confMediaType: ConfMediaType.HWM_CONF_MEDIA_VIDEO,
      subject: this.getSubject(),
      attendees: attendees,
      recordMode: this.getRecordMode(),
      confAllowJoinUser: this.getConfAllowJoinUser(),
      supportWatermark: this.isWatermarkOn,
      isGuestJoinConfWithoutPwd: this.isGuestJoinConfWithoutPwd,
      guestPwd: this.getGuestPwd(),
      isSendEmail: this.isSendEmail,
    }
    const bookConfParam: HWMOpenBookConfParamModel = {
      startTime: this.getStartTime(),
      confLen: this.getConfLen(),
      confCommonParam: confCommonParam,
      isSendCalendarNotify: this.isSendCalendarNotify,
      allowGuestStartConf: this.allowGuestStartConf,
      allowGuestStartConfTime: this.allowGuestStartConfTime
    }
    UISDK.getConfMgrApi().bookConf(bookConfParam).then((res: HWMBookConfResult) => {
      const message: string = res.result === SDKERR.HWM_SDKERR_SUCCESS ? '预约会议成功' : '预约会议失败';
      console.log(message);
    });
}

相关文档