预约会议

更新时间：2024-12-27 GMT+08:00

查看PDF

bookConf

接口描述

该接口用于预约会议。

注意事项

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

方法定义

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

参数描述

表1 HWMOrderConfParam参数说明
参数	是否必须	类型	描述
confSubject	是	NSString *	会议主题
startTime	是	NSTimeInterval	会议开始时间，UTC时间戳，精度秒说明： UTC时间与UTC偏移量（转换为秒）的差值，如东八区为 UTC时间戳 - (8 * 60 * 60)。
duration	否	NSUInteger	会议持续时长，单位分钟，最小值15分钟，最大值1440分钟
confType	是	HWMOrderConfType	会议类型
isNeedConfPwd	否	BOOL	是否需要来宾密码说明：仅对随机会ID生效。
guestPwd	否	NSSting *	来宾密码说明：仅对随机会ID生效。
isRecordOn	否	BOOL	录制会议开关，字段即将废弃，不建议使用。说明：仅对云录制生效，客户端本地录制不生效。
isAutoRecord	否	BOOL	会议开始后是否自动开启录制，默认关闭。开启自动录制会议时必须开启录制会议说明：仅对云录制生效，客户端本地录制不生效。
timeZone	否	NSUInteger	时区，默认值当前时区（中国默认时区56-东八区），详情参考时区表，参数值1-73可用。
vmrId	否	NSString *	个人会议或者云会议室时传入
vmrIdType	否	HWMVmrIdType	VMR会议ID类型
callInRestrictionType	否	HWMJoinConfRestrictionType	允许入会范围限制
attendee	否	NSArray<HWMAttendeeInfo >	与会者信息
isSmsOn	否	BOOL	发送短信通知开关，可选参数，企业配置里面需要开启，否则不生效
isMailOn	否	BOOL	发送邮件通知开发，可选参数，企业配置里面需要开启，否则不生效
isEmailCalenderOn	否	BOOL	发送邮件日历开关
allowGuestStartConf	否	BOOL	是否允许来宾提前启动会议。说明：仅针对随机会议ID的会议生效。固定会议ID的会议，请使用修改云会议室信息接口设置。
allowGuestStartConfTime	否	NSInteger	允许来宾提前入会时间范围（单位：分钟）： 0 - 随时 x - 提前x分钟启动会议说明：仅针对随机会议ID的会议生效。固定会议ID的会议，不支持设置提前入会时间。
isOpenWaitingRoom	否	BOOL	等候室开启开关说明：需要等候室功能开通后才能生效
customInfo	否	NSString *	自定信息（会议详情、会中消息推送可以查看）
concurrentParticipants	否	NSUInteger	会议最大与会人数，默认0
autoMuteMode	否	HWMAutoMuteType	个人客户端入会是否自动静音
hardTerminalAutoMuteMode	否	HWMAutoMuteType	会议室设备入会是否自动静音

表2 枚举HWMOrderConfType说明
参数	描述
OrderConfTypeAudio	音频会议
OrderConfTypeVideo	视频会议

表3 枚举HWMJoinConfRestrictionType说明
参数	值	说明
HWMJoinConfRestrictionAll	0	所有用户
HWMJoinConfRestrictionCompany	2	企业内用户
HWMJoinConfRestrictionInvited	3	被邀请用户

表4 HWMAttendeeInfo 参数说明
参数	是否必传	类型	描述
number	否	NSString *	号码（使用thirdUserId时，此参数可以不传入）
thirdUserId	否	NSString *	APPID 登录场景下的第三方账号
name	否	NSString *	成员名称
email	否	NSString *	邮箱地址
sms	否	NSString *	手机电话
role	否	ConfRoleType	会议成员角色
accountId	否	NSString *	用户UUID（会议详情时字段返回登录账号）
userUuid	否	NSString *	在编辑会议时这个值由会议详情上报，默认是空字符串
isAnonymous	否	BOOL	是否是匿名入会（仅用于获取与会者列表使用）
state	否	HWMConfAttendeeState	与会者状态（仅用于获取与会者列表使用）
orgId	否	NSString *	用于识别是否是本企业账号（仅用于获取与会者列表使用）

表5 枚举ConfRoleType说明
参数	说明
ConfRoleTypeAttendee	普通与会者
ConfRoleTypeChairman	主持人
ConfRoleTypeAudience	观众
ConfRoleTypeCohost	联席主持人

表6 枚举HWMVmrIdType说明
参数	说明
HWMVmrIdTypeFixed	固定类型
HWMVmrIdTypeRandom	随机类型

示例代码

    
     
       
       /// 预约会议
- (void)bookConf {
    HWMOrderConfParam * param = [[HWMOrderConfParam alloc] init];
    param.confSubject = @"会议名称";
    param.startTime = 1598759580;
    param.duration = 15;
    param.confType = HWMConfTypeVideo;
    param.isNeedConfPwd = YES;
    param.isRecordOn = NO;
    param.timeZone = 56;
    param.vmrId = @"";
    param.callInRestrictionType = HWMCallRestrictionAll;
    [[HWMBizSdk getBizOpenApi] bookConf:param callback:^(NSError *_Nullable error, id _Nullable result) {
        if (error) {
            NSLog(@"预约会议失败:%@", error.localizedDescription);
        } else {
            NSLog(@"预约会议成功");
        }
    }];
}

      

    
   

父主题： 会议管理

上一篇：会议管理

下一篇：编辑会议

意见反馈

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

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消

预约会议

bookConf

意见反馈

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

文档反馈