更新时间:2024-08-08 GMT+08:00
分享

预约会议

bookConf

接口描述

该接口用于预约会议。

注意事项

  1. 会议开始时间晚于当前时间。
  2. 个人会议或者云会议室的时候要传入vmrId。
  3. 携带与会者入会的时候需要传入attendee。
  4. 开启自动录制会议时必须开启录制会议。
  5. callback中的result返回会议详情信息 (HWMConfDetail)。

方法定义

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

参数描述

表1 HWMOrderConfParam参数说明

参数

是否必须

类型

描述

confSubject

NSString *

会议主题

startTime

NSTimeInterval

会议开始时间,UTC时间戳,精度秒

duration

NSUInteger

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

isAutoRecord

BOOL

会议开始后是否自动开启录制,默认关闭。开启自动录制会议时必须开启录制会议

timeZone

NSUInteger

时区,默认值当前时区(中国默认时区56-东八区),详情参考时区表,参数值1-73可用。

vmrId

NSString *

个人会议或者云会议室时传入

callInRestrictionType

HWMJoinConfRestrictionType

允许入会范围限制

attendee

NSArray<HWMAttendeeInfo *> *

与会者信息

isSmsOn

BOOL

发送短信通知开关,可选参数,企业配置里面需要开启,否则不生效

isMailOn

BOOL

发送邮件通知开发,可选参数,企业配置里面需要开启,否则不生效

isEmailCalenderOn

BOOL

发送邮件日历开关

noPassword

BOOL

会议是否无密码,默认为否(只针对随机VMR会议有效)

guestPwd

NSString

指定来宾入会密码,默认空表示随机生成密码(只针对随机VMR会议有效)

isVideo

BOOL

是否创建视频会议,默认是YES。选NO则创建语音会议

vmrConfIdType

HWMVmrConfIdType

云会议室的会议ID类型,默认固定类型

allowGuestStartConf

BOOL

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

说明:

allowGuestStartConfTime

NSUInteger

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

0 - 随时

x - 提前x分钟启动会议

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

isOpenWaitingRoom

BOOL

是否开启等候室

说明:

需要等候室功能开通后才能生效。

isRecordOn

BOOL

是否开启录制

customInfo

NSString *

自定义信息(会议详情、会中消息推送可以查看)

concurrentParticipants

NSUInteger

会议最大与会人数,默认0

confResType

HWMConfResType

会议资源类型

autoMuteMode

HWMAutoMuteType

来宾入会,软终端是否自动静音。

hardTerminalAutoMuteMode

HWMAutoMuteType

来宾入会,硬终端是否自动静音。

表2 枚举HWMJoinConfRestrictionType说明

参数

说明

HWMJoinConfRestrictionAll

0

所有用户

HWMJoinConfRestrictionCompany

2

企业内用户

HWMJoinConfRestrictionInvited

3

被邀请用户

表3 HWMAttendeeInfo 参数说明

参数

是否必传

类型

描述

number

NSString *

账号、密码场鉴权情况下必填

thirdUserId

NSString *

第三方账号,APP ID 鉴权场景下必填

name

NSString *

会场名称

email

NSString *

邮箱地址

sms

NSString *

手机电话

role

HWMConfRoleType

会议成员角色

accountId

NSString *

用户UUID(会议详情时字段返回登录账号)

mute

BOOL

是否静音

isAnonymous

BOOL

是否是匿名入会(仅用于获取与会者列表使用)

state

HWMAttendeeState

与会者状态(仅用于获取与会者列表使用)

orgId

NSString *

用于识别是否是本企业账号(仅用于获取与会者列表使用)

表4 枚举HWMConfRoleType说明

参数

说明

HWMConfRoleTypeAttendee

普通与会者

HWMConfRoleTypeChairman

主持人

表5 枚举HWMVmrConfIdType说明

枚举值

描述

HWMVmrConfIdTypeFixed

云会议室的会议ID类型是固定类型。

HWMVmrConfIdTypeRandom

云会议室的会议ID类型是随机类型。

示例代码

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
/// 预约会议
- (void)bookConf {
    HWMOrderConfParam * param = [[HWMOrderConfParam alloc] init];
    param.confSubject = @"会议名称";
    param.startTime = 1598759580;
    param.duration = 15;
    param.isAutoRecord = NO;
    param.timeZone = 56;
    param.vmrId = @"";
    param.attendee = self.attenteeArr;
    param.callInRestrictionType = HWMCallRestrictionAll;
    [[HWMBizSdk getBizOpenApi] bookConf:param callback:^(NSError *_Nullable error, id _Nullable result) {
        if (error) {
            NSLog(@"预约会议失败:%@", error.localizedDescription);
        } else {
            NSLog(@"预约会议成功");
        }
    }];
}

相关文档