文档帮助平台
首页服务端API参考 云会议室管理 查询云会议室详情
查询云会议室详情
更新时间：2025-09-15 04:37:04

查询云会议室详情

请求方法

GET

请求地址

/vmrs/{vmrId}

请求参数

参数 参数类型 数据类型 是否必需 描述
vmrId Path String 是 vmr id，长度32

HTTP状态码

返回值 描述
200 操作成功，详见响应参数
400 客户端传参异常
401 鉴权失败
500 服务端异常

响应参数

参数 参数类型 描述
id String vmrId
name String 名称
number String 会议号码
extension String 会议短号
password String 密码
profile String 会议模式，0：会议模式；1：授课模式；2：研讨会模式
groupId String 分组Id
groupName String 分组名称
organizerName String 组织者名称
syncDirectory Boolean 是否同步地址簿
defaultLayout Integer 默认布局。1，1+N模式；2，等分模式
participants Participant[] 参会者信息
enableJoinAutoMute Boolean 入会自动静音
enableAutoRecord Boolean 自动录制
enableRtmp Boolean 是否启用RTMP
enableWaitingRoom Boolean 是否启用会议等候室
waitingRoomMode Integer 会议等候室设置，0=企业内所有人；1=仅主持人；2=企业内所有人及受邀参会者；3=仅受邀参会者
enableJoinForwardModerator Boolean 是否允许在主持人之前加入
enableOnlyLoginUserJoin Boolean 是否启用仅登录用户入会
enableWatermark Boolean 是否启用会议水印
watermarkTransparency Integer 水印透明度，0：浅；1：中；2：深
watermarkFontSize Integer 水印文字大小，0：小；1：中；2：大
enableScreenShareWatermark Boolean 是否启用屏幕共享水印（已废弃，建议使用enableWatermark参数）
speakMode Integer 发言模式。0，自由发言；1，申请发言
voicePromptMode Integer 入会与离会提示音，0：不开启；1：仅入会方接收提示音；2：仅入会方和主持人接收提示音；3：所有参会方接收提示音。默认1：仅入会方接收提示音
chatPermissionsByAttendees Integer 聊天权限-与会者，可选值：0：允许群聊和私聊，1：仅允许群聊，2：仅允许私聊主持人，3：全体成员禁言
enableChatPermissionsByAudience Boolean 是否启用聊天权限-观众
sharePermissions Integer 共享权限，可选值：0：所有参会者，1：仅主持人可共享
annotationPermissions Integer 批注权限，可选值：0：所有参会者，1：仅共享者和主持人
enableRenamePermissions Boolean 是否启用改名权限
enableUnmuteRequiresUserConsent Boolean 是否启用解除静音需用户同意
rtmpLayout Integer 网络直播布局，可选值：1：演讲者模式，2：单方全屏模式
enableCloudRecording Boolean 是否启用云端录制
recordTypeList List<Integer> 录制方式，可选值：0：录制视频和音频，1：独立录制辅流，2：独立录制音频，3：录制发言者
recordLayout Integer 云端录制布局，可选值：1：演讲者模式，2：画中画模式，3：等分布局
rtmpWatchUrl String 直播观看链接
enableHostKey Boolean 是否启用主持人秘钥
hostKey String 主持人秘钥
joinLink String 入会链接

Participant对象定义

参数 数据类型 描述
participantId String 人员id
participantRole Integer 人员角色；0：组织者；1：主持人；2：参会者

请求消息示例

GET /v2/vmrs/147d94feddaf4d4f85dbb773f196b703 HTTP/1.1
Host: api.ylyun.com
Content-Type: application/json

响应消息示例

HTTP/1.1 200 
Content-Type: application/json;charset=UTF-8

{
    "id": "147d94feddaf4d4f85dbb773f196b703", 
    "name": "test", 
    "number": "824230910006", 
    "extension": "10006", 
    "password": "346237", 
    "groupName": "大帅-dev企业", 
    "groupId": "452ae18eb3164c999d197f97f9d4fd72", 
    "organizerName": null, 
    "syncDirectory": true, 
    "participants": [
        {
            "participantId": "d96d779354e94d55a2299052a9a12f1c", 
            "participantRole": 2
        }, 
        {
            "participantId": "64bb26c0065b4a54b0dd659e365e93b9", 
            "participantRole": 0
        }
    ], 
    "enableJoinAutoMute": false, 
    "voicePromptMode": 1, 
    "defaultLayout": 1, 
    "enableRtmp": false, 
    "enableAutoRecord": false,
    "enableJoinForwardModerator": true,
    "enableWaitingRoom": false,
    "waitingRoomMode": 0,
    "enableWatermark ": false,
    "watermarkTransparency": 1,
    "watermarkFontSize": 1,
    "enableScreenShareWatermark": false,
    "enableOnlyLoginUserJoin": false,
    "speakMode": 0,
    "chatPermissionsByAttendees": 0,
    "enableChatPermissionsByAudience": false,
    "sharePermissions": 0,
    "annotationPermissions": 0,
    "enableRenamePermissions": true,
    "enableUnmuteRequiresUserConsent": false,
    "rtmpLayout": 1,
    "enableCloudRecording": true,
    "recordTypeList": [0],
    "recordLayout": 1,
    "enableHostKey": true,
    "hostKey": "123456",
    "joinLink": "http://127.0.0.1/join/v?i=ESHk5B3Lc",
    "rtmpWatchUrl": "https://meetings.ylyun.com/live-player?meeting=IT6W5Yr7eYlAd9vI1qZlbg%3D%3D&number=111111"
}

CURL命令示例

curl -XGET -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8' 'https://api.ylyun.com/v2/vmrs/147d94feddaf4d4f85dbb773f196b703'
本页目录