获取会议配置信息
获取会议配置信息
简要描述:
获取会议配置的基本信息,根据configKey获取不同的配置信息
请求参数:
ConfigKey option:
| key | 描述 |
|---|---|
| GENERAL | 通用设置 |
| VIDEO_MEETING | 视频会议设置 |
| STREAMING | 直播配置 |
| RECORDING | 录播配置 |
| NTEWORK_MEETING | 网络会议配置 |
| TENCENT_MEETING | 腾讯会议配置 |
| TENANT_ACCOUNT | 租户资源配置 |
请求例子:
- 通过CDN方式引入使用
<script src="https://cdn.jsdelivr.net/npm/umeet-js-sdk@1.0.16/UmeetJsSdk.min.js" type="text/javascript"></script> <script type="text/javascript"> // 获取会议配置信息 var configKey = 'GENERAL'; function getConfigurations() { UmeetJsSdk.getConfigurations(configKey, function (res) { console.log(res) if (res.status === 200) { } else { console.log(res.data.message) } }) } </script> - 通过NPM引入使用
import UmeetJsSdk from 'umeet-js-sdk'; /** * 获取会议配置项 * @params key STRING 获取的配置类型 * **GENERAL 通用设置 * **VIDEO_MEETING 视频会议设置 * **STREAMING 直播配置 * **RECORDING 录播配置 * **NTEWORK_MEETING 网络配置 */ getConfigurations () { let that = this; const configKey = 'GENERAL'; UmeetJsSdk.getConfigurations(configKey).then(res => { console.log(res) if (res.status === 200) { console.log(res) } else { console.log(res.data.message) } }) }
响应结果:
请求成功时,http status code =200,响应体内容如下:
GENERAL object.
| Parameters | Type/Value | Description |
|---|---|---|
| roomAvailableTime | [array] | 会议室可预约时间,如:[7:00,23:00] |
| appointmentInterval | [int] | 预约时间间隔,分钟 |
| preparationTime | [int] | 会前准备时间,分钟 |
| periodicMeeting | [boolean] | 周期会议,true(开启) |
| meetingAssistant | [boolean] | 会议助手,true(开启) |
| meetingService | [boolean] | 会议服务,true(开启) |
| meetingAttendance | [boolean] | 会议考勤,true(开启) |
| multiSelectionRoom | [boolean] | 多选会议室,true(开启) |
| releaseRoom | [boolean] | 释放会议室,true(开启) |
| roomCheckTime | [int] | 热感释放会议室的时间,分钟 |
| confirmUseRoom | [boolean] | 确认使用会议室是否开启, true(开启) |
| roomConfirmTime | [int] | 确认使用时间限制,分钟 |
| maximumDuration | [int] | 会议最大时长,小时 |
| reservedTime | [int] | 预留时长,小时 |
| liveFlag | [boolean] | 直播开关,true 开启 |
| publicFlag | [boolean] | 公共会议开关,true 开启 |
VIDEO_MEETING object.
| Parameters | Type/Value | Description |
|---|---|---|
| autoCall | [boolean] | 自动呼叫,true(开启) |
| customNumber | [boolean] | 自定义会议号,true(开启) |
| autoReconnection | [boolean] | 自动重连,true(开启) |
| endMode | [string] | 结束模式,RESERVATION(按预定时间)、INTELLIGENT(智能检测)、LIMT(最大时长) |
STREAMING object.
| Parameters | Type/Value | Description |
|---|---|---|
| enable | [boolean] | 是否开启直播,true(开启) |
| address | [string] | 推流地址 |
RECORDING object.
| Parameters | Type/Value | Description |
|---|---|---|
| enable | [boolean] | 是否开启录播,true(开启) |
| address | [string] | 点播地址 |
NTEWORK_MEETING object.
| Parameters | Type/Value | Description |
|---|---|---|
| customLink | [boolean] | 是否开启自定义主持人及参会者入会链接,true:开启 |
| hosts | [array] | 网络会议级联地址 |
| urlSchema | [string] | 用户自定义schema前缀 |
| monitorUrl | [string] | 监控跳转的url |
| appPackage | [string] | 应用包名 |
| useSameNumber | [boolean] | 视频会议是否使用网络会议会议号,true(开启) |
| resourceType | [string] | 资源类型,PUBLIC_MEETING_ROOM(公共会议室),PRIVATE_MEETING_ROOM(个人会议室), AUTO_MEETING_ROOM(个人&公共会议室) |
| networkMeetingControl | [boolean] | 是否开启网络会议监控 |
| meetingControl | [object] | 会控页面参数 |
| onlyParCanJoin | [boolean] | 仅受邀人可入会 |
| screenWatermark | [boolean] | 屏幕水印 |
| zoomMeeting | [boolean] | 是否支持加入zoom会议 |
| numberAutoRelease | [boolean] | 自动释放会议号(默认true,true-定时检查会中参会者,没有则自动释放,false-不释放会议号) |
meetingControl object.
| Parameters | Type/Value | Description |
|---|---|---|
| domain | [String] | 网络会议监控地址 |
| account | [string] | 登录账号 |
| password | [string]密码 |
TENCENT_MEETING object.
| Parameters | Type/Value | Description |
|---|---|---|
| enable | [boolean] | 是否开启,true:开启 |
| appId | [String] | AppId |
| sdkId | [string] | SdkId |
| secretId | [string]SecretId | |
| secretKey | [string] | SecretKey |
TENANT_ACCOUNT object.
| Parameters | Type/Value | Description |
|---|---|---|
| name | [string] | 会议类型名称,小于10个字符 |
| domain | [string] | 服务器地址 |
| apiKey | [string] | api key |
| apiSecret | [string] | api secret |
| appKey | [string] | app key |
| appSecret | [string] | app secret |
| resourceType | [string] | 资源类型,默认公共会议室,PUBLIC_MEETING_ROOM(公共会议室),PRIVATE_MEETING_ROOM(个人会议室), AUTO_MEETING_ROOM(个人&公共会议室) |
| urlSchema | [string] | url schema |
| appPackage | [string] | app package |
| joinUrlPrefix | [string] | 入会链接前缀 |
| useSameNumber | [boolean] | 是否使用相同的会议号 |
| enable | [boolean] | 是否启用, true:启用, false:不启用 |
| hosts | [array] | 级联地址列表 |
| roles | [array] | 关联角色id列表 |
如:
{
status: 200,
data: {
GENERAL
VIDEO_MEETING
STREAMING
RECORDING
NTEWORK_MEETING
meetingControl
TENCENT_MEETING
TENANT_ACCOUNT
}
...
}