融合会议管理平台
  1. 管理员
融合会议管理平台
  • 快速入门
    • 概述
  • 开发指南
    • 开发前必读
    • 视频会议系统实时消息对接文档
  • API
    • 认证
      • 获取客户端令牌
      • 生成访问令牌
      • 获取access_token
    • 首页
      • 权益
        • 查询视频会议权益
      • 在线状态
        • 查询用户/设备在线状态
        • 查询员工/设备在线总数
    • 会话控制
      • 会话选项
        • 配置会话选项
        • 查询会话选项
      • 主会场
        • 设置主会场轮询
        • 设置/取消主会场
        • 取消主会场轮询
        • 开始主会场轮询
        • 暂停主会场轮询
      • 会场管理
        • 会场布局
          • 保存并应用端点自定义布局
          • 应用端点自定义布局
          • 更新端点自定义布局
          • 删除端点自定义布局
          • 查询端点自定义布局列表
        • 关闭会场麦克风
        • 开启麦克风/主持人申请开启麦克风
        • 全体关闭麦克风
        • 全体开启麦克风
        • 开启/申请开启摄像头
        • 关闭摄像头
        • 拒绝开启摄像头
        • 关闭扬声器
        • 开启扬声器
        • 全体关闭扬声器
        • 全体开启扬声器
        • 开启本地录制
        • 关闭本地录制
        • 会场举手
        • 会场取消举手
        • 主持人接受举手请求
        • 主持人拒绝举手请求
        • 设置主持人/取消主持人
        • 获取当前端点的角色
        • 转移主持人
        • 获取会议成员列表
        • 端点申请成为主持人
        • 拒绝开启音频
        • 修改端点展示状态
        • 点名/点名看主会场
        • 设置端点观看会场
        • 锁定/解锁观看会场
        • 修改端点音频增益配置
        • 控制会场摄像头
        • 开启端点字幕
        • 停止端点字幕
        • 会中改名
      • 呼叫
        • 批量取消呼叫
        • 获取当前呼叫限制数
      • 会话布局
        • 保存并应用会话自定义布局
        • 应用会话自定义布局
        • 更新会话自定义布局
        • 删除会话自定义布局
        • 查询会话自定义布局列表
        • 广播会场/广播轮询/广播多画面
        • 广播单会场
        • 取消广播
        • 暂停布局轮询
        • 开始布局轮询
      • 等候室
        • 将等候室成员移入会议
        • 将会中成员移入等候室
        • 将等候室成员移出等候室
      • 会议管理
        • 个人用户
          • 分页查询会议的会场列表
      • 媒体服务回调
        • 媒体服务异常或端点掉线异常通知
        • 媒体录制服务完成录制时的回调接口
        • 媒体服务通用的回调接口
      • 创建会话
      • 关闭会话
      • 加入会话
      • 隐身入会
      • web 会控入会
      • 退出会话/踢出会话
      • 获取会话详情
      • 根据会议号查询端点和会话信息
      • 开启录制
      • 停止录制
      • 开启横幅
      • 停止横幅
      • 切换会话模式
      • 语音激励设置
      • 是否部署录制服务
      • 获取第三方网关信息
      • 开启字幕
      • 停止字幕
      • 更新会话模式状态
      • 更新会话模式中的设置
      • 获取会话状态
    • 虚拟会议室
      • 管理员
        • 生成一个当时可用的会议号
          POST
        • 创建云会议室
          POST
        • 更新虚拟会议室信息
          PUT
        • 获取云会议室信息
          GET
        • 删除云会议室
          POST
        • 通过会议号查询云会议室信息
          GET
        • 获取企业的云会议室列表
          GET
      • 个人用户
        • 获取会议室信息
        • 更新虚拟会议室信息
    • 历史会议管理
      • 个人用户
        • 获取会议记录列表
        • 获取会议记录详情
        • 导出全部会议记录
      • 管理员
        • 获取会议记录列表
        • 获取会议记录详情
        • 导出全部会议记录
    • 会议管理
      • 个人用户
        • 获取企业低码高清配置信息
        • 预约会议
        • 获取媒体能力参数
        • 修改会议信息
        • 取消会议
        • 取消会议
        • 查询会议信息
        • 根据sessionId查询会议id
        • 查询会议列表
        • 分页查询会议的会场列表
        • 更新会场排序
        • 移除会场
        • 获取企业的默认会议设置
      • 管理员
        • 修改会议信息
        • 取消会议
        • 取消会议
        • 查询会议信息
        • 根据sessionId查询会议id
        • 查询会议列表
        • 更新企业的默认会议设置
    • 组织架构管理
      • 获取所有员工组织架构
      • 新增组织架构
      • 获取所有组织信息列表
      • 编辑组织架构
      • 删除组织架构
      • 获取组织架构
    • 企业设置
      • 管理员
        • 修改企业通用设置
        • 修改企业邮箱设置
        • 获取企业邮箱设置
        • 发送测试邮件
        • 更新网页页面设置
      • 用户
        • 查询企业通用设置
        • 查询网页页面设置
        • 获取 MaxHub 服务配置
    • 员工信息
      • 管理员
        • 新增员工
        • 修改账号密码
        • 删除员工信息
        • 修改员工信息
        • 批量删除员工信息
        • 更改员工部门
        • 批量创建员工信息
        • 导出员工
        • 获取导入用户任务
        • 搜索企业员工
        • 获取企业员工人数
    • 资产设备信息
      • 管理员
        • 根据终端账号查询终端信息
        • AVC设备资产注册
        • 获取自动注册所需账密信息
    • 会议模版管理
      • 管理员
        • 分页查询会议模版
      • 个人用户
        • 创建会议模版
        • 更新会议模版
        • 批量删除会议模版
        • 分页查询会议模版
        • 查询会议模版详情
    • 数据统计
      • 查询数据统计
    • 系统报告
      • 分页查询系统报告
      • 批量阅读系统报告
    • 管理员日志
      • 分页查询管理员日志
      • 通知用户上传日志
    • 终端分组管理
      • 管理员
        • 获取终端分组列表
        • 新增分组
        • 编辑分组
        • 获取分组
        • 删除分组
      • 个人用户
        • 获取所有终端分组列表
    • 录制文件管理
      • 获取录制文件目录列表
      • 获取某个目录文件下的文件列表
      • 获取文件下载地址
      • 删除录制文件
      • 获取企业拥有的空间详情
      • 下载文件 (只有私有化使用)
      • 重命名录制文件
      • 预览录制文件
      • 获取单个文件的详情
      • 下载录制文件
    • 运维工具
      • 网络抓包
        • 查询可监听网卡
        • 查询抓包记录
        • 删除抓包记录
        • 开始抓包任务
        • 停止抓包任务
        • 查询抓包任务
      • 日志导出
        • 查询服务模块
        • 开始导出任务
        • 查询导出任务
      • 自动化接口
        • 修改客户端版本开关状态
      • 音频转储
        • 开始音频转储任务
        • 停止音频转储任务
        • 获取音频转储任务状态
        • 获取音频转储记录
        • 批量删除音频转储任务记录
      • 获取节点列表
      • 获取节点硬件信息
    • 呼叫
      • 发起呼叫
      • 拒绝呼叫
    • 端口监听
      • 开始监听
      • 关闭监听
      • 查询正在监听的端口列表
    • 服务区管理
      • 根据终端账号或IP匹配服务区
      • 获取服务区列表
      • 获取服务器和服务区之间的分布信息
      • 根据ID获取服务区
      • 批量查询服务区信息
      • 新增服务区
      • 更新服务区
      • 删除服务区
      • [自动化测试使用] 设置服务区连通模式
    • 服务器管理
      • 获取穿越服务器信息
      • [自动化测试使用] 获取穿越服务器信息
      • 获取服务器列表
      • 获取服务器详情
      • 新增服务器
      • 更新服务器
      • 删除服务器
      • 生成或重置服务器密钥
      • 查询服务器密钥过期时间
      • 加入服务器集群
    • 终端管理
      • 导入企业资产设备信息列表
      • 导出企业资产设备信息
      • 查询企业下的设备资产
      • 批量删除企业的设备资产
      • 添加资产到企业
      • 修改企业设备资产信息
      • 转移设备到新分组
      • 获取企业设备资产信息
      • 批量获取设备信息
      • 根据服务区生成设备账号
      • 校验设备账号或IP是否匹配服务区的区号或IP段规则
    • 数据平台
      • 数据上报接口
      • filebeat 上报数据接口
      • 导出数据
  1. 管理员

通过会议号查询云会议室信息

GET
/rsc/api/v2/admin/virtual-rooms/info
当云会议室不存在时,会抛出云会议室不存在的异常

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Query 参数
code
string 
会议号
必需

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/rsc/api/v2/admin/virtual-rooms/info?code'

返回响应

🟢200成功
application/json
Body
云会议室
isUsed
boolean  | null 
必需
云会议室是否正在使用
id
string <int64> | null 
云会议室id
必需
code
string  | null 
会议号
必需
name
string  | null 
会议室名称
必需
password
string  | null 
必需
密码
见 TSMB-5634 安卓手机端取这个路径下的密码
type
enum<integer>  | enum<null> 
必需
云会议室类型,1为随机,2为个人,3为企业
枚举值:
123
option
会议室设置
必需
Any of
云会议室
allowJoinBeforeMaster
boolean  | null 
必需
是否允许参会人在主持人之前入会,false不允许,true允许,默认true
默认值:
true
password
string  | null 
会议密码
必需
autoMuteType
enum<integer>  | enum<null> 
必需
参会人入会自动静音类型,0不静音,1静音,2超过一定人数自动静音
枚举值:
012
默认值:
{value: 0}
autoCallEnabled
boolean  | null 
必需
是否激活时自动呼叫参会人,默认为 false
默认值:
false
autoRecordEnabled
boolean  | null 
会话自动开启录制
必需
默认值:
false
recordLayoutMode
enum<integer>  | enum<null> 
必需
录制布局策略: 0-云录制视图优先, 1-广播布局优先。只有在autoRecord为true时有效
枚举值:
01
默认值:
{value: 1}
recordLayoutTemplate
string  | null 
必需
用户录制布局,具体值由媒体决定。只有在autoRecord为true时有效
bannerEnabled
boolean  | null 
横幅是否开启
必需
默认值:
false
bannerInfo
object  | null 
横幅内容
必需
mediaCapabilityOptions
媒体能力参数设置
必需
applyMasterEnabled
boolean 
是否开启主持人密码
可选
默认值:
false
masterPassword
string 
主持人密码
可选
masterPasswordTimes
integer 
可选
主持人密码使用限制次数
默认值:
10
maxEndpointCount
integer 
可选
云会议室的最大入会方数,最大不超过技术上限制的最大方数。小于或等于0则表示没有限制
默认值:
-1
joinPermissionRangeType
enum<integer>  | enum<null> 
必需
云会议室参会范围类型, 0为所有会场,1为指定的会场
枚举值:
01
默认值:
{value: 0}
layoutOptions
array[object (LayoutOptionResponse) {4}]  | null 
会议布局信息
必需
uid
string  | null 
用户id
必需
uidType
enum<integer>  | enum<null> 
设备id
必需
枚举值:
0123
companyId
string  | null 
企业id
必需
venues
array[object (MeetingVenueResponse) {8}] 
会场列表
可选
uid
string 
会场id
可选
uidType
enum<integer> 
会场类型
可选
枚举值:
0123
displayName
string 
会场名称
可选
identifier
string 
可选
会场标识,账号、终端号、IP信息等会场唯一标识
accessType
enum<string> 
接入类型
可选
枚举值:
未知SVCH.323SIP
groupName
string 
分组名称
可选
groupId
string 
分组id
可选
companyId
string 
企业id
可选
示例
{
  "isUsed": false,
  "id": "",
  "code": "",
  "name": "",
  "type": 0,
  "option": {
    "password": "",
    "autoMuteType": 0,
    "autoCallEnabled": false,
    "autoRecordEnabled": false,
    "recordLayoutMode": 0,
    "recordLayoutTemplate": "",
    "bannerEnabled": false,
    "bannerInfo": {},
    "mediaCapabilityOptions": {
      "bitRate": "",
      "mediaCrypto": "",
      "frameRate": "",
      "videoResolution": "",
      "videoCodecs": "",
      "audioCodecs": ""
    },
    "joinBeforeMasterEnabled": false,
    "applyMasterEnabled": false,
    "masterPassword": "",
    "masterPasswordTimes": 0,
    "maxEndpointCount": 0,
    "joinPermissionRangeType": 0,
    "layoutOptions": [
      {
        "id": "",
        "apply": false,
        "type": 0,
        "content": "",
        "index": 0,
        "createdTime": "",
        "updatedTime": "",
        "applyTime": ""
      }
    ]
  },
  "uid": "",
  "uidType": 0,
  "companyId": "",
  "venues": [
    {
      "uid": "",
      "uidType": 0,
      "displayName": "",
      "identifier": "",
      "accessType": "",
      "groupName": "",
      "groupId": "",
      "companyId": ""
    }
  ]
}
上一页
删除云会议室
下一页
获取企业的云会议室列表
Built with