获取会议详情
getConfDetail
接口描述
该接口用于获取会议的详细信息。
注意事项
该接口在已登录状态下才能调用。
方法定义
1
|
getConfDetail(confId: string): Promise<HWMQueryConfInfoResult>; |
参数描述
|
参数 |
是否必须 |
类型 |
描述 |
|---|---|---|---|
|
confId |
是 |
string |
会议ID。 |
返回值
|
参数 |
类型 |
描述 |
|---|---|---|
|
result |
SDKERR |
接口调用结果，HWM_SDKERR_SUCCESS表示成功，详细请参考错误码参考。 |
|
reasonDesc |
string |
错误描述。 |
|
confDetailInfo |
会议详情。 |
|
参数名称 |
参数类型 |
参数说明 |
|---|---|---|
|
baseInfo |
会议基本信息。 |
|
|
vmrId |
string |
云会议室唯一ID。 |
|
isVmr |
boolean |
是否是vmr会议。 |
|
isAutoRecord |
boolean |
是否开启自动录制会议。 |
|
isSmsOn |
boolean |
是否发送短信通知。 |
|
isMailOn |
boolean |
是否发送邮件通知。 |
|
isEmailCalenderOn |
boolean |
是否发送日历通知。 |
|
confAllowJoinUserType |
会议准入设置。 |
|
|
attendeeList |
与会者列表。 |
|
|
isOpenWaitingRoom |
boolean |
是否开启等候室。 |
|
allowGuestStartConf |
boolean |
允许来宾启动会议。 |
|
allowGuestStartConfTime |
number |
允许来宾提前入会时间范围(单位：分钟) 0-随时，n-提前n分钟启动会议。 |
|
maxAttendeeSize |
number |
会议方数，会议最大与会人数限制. 0: 无限制, 大于0: 会议最大与会人数。 |
|
参数名称 |
参数类型 |
参数说明 |
|---|---|---|
|
confId |
string |
会议ID。 |
|
confSubject |
string |
会议主题。 |
|
hostPwd |
string |
主持人密码。 |
|
guestPwd |
string |
来宾密码。 |
|
startTimeStamp |
number |
会议开始时间(时间戳，单位秒)。 |
|
endTimeStamp |
number |
会议结束时间(时间戳，单位秒)。 |
|
timezone |
string |
时区码。 |
|
schedulerName |
string |
会议预定者名称。 |
|
vmrConfId |
string |
用于云会议显示的ID。 |
|
hostJoinUri |
string |
主持人加入会议uri链接。 |
|
guestJoinUri |
string |
来宾加入会议uri链接。 |
|
selfConfRole |
本人在会议中的角色。 |
|
|
conferenceType |
会议类型。 |
|
|
cycleParam |
周期会议的参数。 |
|
|
subConfParam |
Array<HWMSubCycleConfParamModel> |
周期子会议参数。 |
示例代码
1 2 3 4 5 6 7 8 9 |
/** * 获取会议详情 */ handleGetConfDetail() { UISDK.getConfMgrApi().getConfDetail(confId).then((res: HWMQueryConfInfoResult) => { const message: string = res.result === SDKERR.HWM_SDKERR_SUCCESS ? '获取会议详情成功' : '获取会议详情失败' + res.result; console.log(message); }); } |
