文档帮助平台
首页服务端API参考 云会议室管理 查询云会议室详情
查询云会议室详情
更新时间：2025-08-26 07:38:18

查询云会议室详情

请求方法

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 密码
groupId String 分组Id
groupName String 分组名称
defaultLayout Integer 默认布局。1，1+N模式；2，等分模式
organizerName String 组织者名称
syncDirectory Boolean 是否同步地址簿
participants Participant[] 参会者信息
enableJoinAutoMute Boolean 入会自动静音，默认false
enableAutoRecord Boolean 自动录制，默认false
voicePromptMode Integer 入会与离会提示音，0：无提示；1：仅入会方接收提示音；2：仅入会方和主持人接收提示音；3：所有参会方接收提示音。默认1：仅入会方接收提示音
enableRtmp Boolean 是否启用RTMP，默认false
enableShowRoomName Boolean 第三方终端设置，是否显示会场名称
enableShowRoomStateIcon Boolean 第三方终端设置，是否显示会场状态
maxBandwidth String 最大呼叫带宽
maxSecondaryFlowResolution String 最大辅流分辨率
maxVideoResolution String 最大视频分辨率
enableWaitingRoom Boolean 是否启用会议等候室
~~waitingRoomMode~~ Integer 已废弃，，支持旧版本兼容,请使用waitingRoomModeList这个字段。会议等候室设置，可选值：0=企业内所有人；1=仅主持人；2=企业内所有人及受邀参会者；3=仅受邀参会者
profile Integer 会议模式 0：视频会议模式； 2：研讨会模式； 3：语音会议模式
enableJoinForwardModerator Boolean 是否允许在主持人之前加入
~~enableScreenShareWatermark~~ Boolean 已废弃，支持旧版本兼容,请使用enableWatermark字段。是否启用屏幕共享水印
enableWatermark Boolean 是否启用水印
watermarkTransparency Integer 水印透明度，0：浅；1：中；2：深
watermarkFontSize Integer 水印文字大小，0：小；1：中；2：大
enableOnlyLoginUserJoin Boolean 是否启用仅登录用户入会
speakMode Integer 发言模式。0，自由发言；1，申请发言
attendeesDefaultLayout Integer 与会者入会默认布局，1：演讲者，2：画中画
enableUniqueParticipantResidenceTime Boolean 允许设置仅一个与会者停留时自动结束会议时间
enableNoModeratorTime Boolean 允许设置无主持人自动结束会议
chatPermissionsByAttendees Integer 聊天权限-与会者，可选值：0：允许群聊和私聊，1：仅允许群聊，2：仅允许私聊主持人，3：全体成员禁言
sharePermissions Integer 共享权限，可选值：0：所有参会者，1：仅主持人可共享
annotationPermissions Integer 批注权限，可选值：0：所有参会者，1：仅共享者和主持人
enableRenamePermissions Boolean 是否启用改名权限
enableUnmuteRequiresUserConsent Boolean 是否启用解除静音需用户同意
enableOpenVideoRequiresUserConsent Boolean 是否开启视频需要用户同意
enableChatHistoryExport Boolean 是否允许聊天记录导出
recordTypeList Integer[] 录制方式，可选值：0：录制视频和音频，1：录制独立辅流，2：录制独立音频，3：录制发言者，可多选
rtmpLayout Integer 网络直播布局，可选值：1：演讲者模式，2：画中画模式
waitingRoomModeList Integer[] 会议等候室设置（新），可选值：0=开启企业内所有人；1=开启受邀参会者；2=开启第三方入会IP白名单
enableRtsp Boolean 是否开启RTSP推流功能
rtspLiveVideoResolution String 推流分辨率，可选值：4K/30FPS、1080P/30FPS、720P/30FPS
rtspPushLayout Integer 推流布局，可选值：1，演讲者模式；2，画中画模式；5，自定义布局模式
rtspPushUrlType Integer 推流地址类型，可选值：0，固定；1，随机；
rtspRegion String RTSP直播下沉区域
rtmpWatchPwd String 直播密码，密码长度为4位。设置直播密码时,rtmpWatchLimitType的值应设置为1
rtmpRichTextRemark String 直播介绍
rtmpWatchLimitType Integer 直播观看限制类型，0：所有人，1：需要密码
enableOwnLive Boolean 是否启用自有直播
rtmpWatchUrl String rtmp直播观看链接
ownLiveWatchUrl String 自有直播链接

Participant对象定义

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

请求消息示例

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

响应消息示例

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

{
    "id": "fb493afba9064b05b94bd2ccefae1db4",
    "name": "name",
    "number": "30808121315",
    "password": "843724",
    "profile": "0",
    "groupId": "3197a2776fb14471b36486f86bf649ab",
    "organizerName": "hujc@yealink.com",
    "syncDirectory": true,
    "participants": [
        {
            "participantId": "501070776b1946dcb3f71a6297901aa1",
            "participantRole": 0
        }
    ],
    "enableJoinAutoMute": true,
    "voicePromptMode": 1,
    "enableRtmp": true,
    "extension": "21315",
    "groupName": "hujc@yealink.com",
    "defaultLayout": 1,
    "enableAutoRecord": true,
    "enableShowRoomName": true,
    "enableShowRoomStateIcon": true,
    "maxVideoResolution": "1080P/30FPS",
    "maxSecondaryFlowResolution": "1080P/30FPS",
    "maxBandwidth": "2Mbps",
    "enableWaitingRoom": false,
    "waitingRoomMode": 3,
    "enableJoinForwardModerator": true,
    "enableScreenShareWatermark": false,
    "enableWatermark": false,
    "watermarkTransparency": 1, 
    "watermarkFontSize": 1,  
    "enableOnlyLoginUserJoin": true,
    "speakMode": 0,
    "attendeesDefaultLayout": 1,
    "enableUniqueParticipantResidenceTime": true,
    "enableNoModeratorTime": true,
    "chatPermissionsByAttendees": 0,
    "sharePermissions": 0,
    "annotationPermissions": 0,
    "enableRenamePermissions": true,
    "enableUnmuteRequiresUserConsent": true,
    "enableOpenVideoRequiresUserConsent": true,
    "enableChatHistoryExport": true,
    "enableRtsp": true,
    "rtspLiveVideoResolution": "1080P/30FPS",
    "rtspPushLayout": 1,
    "rtspPushUrlType": 0,
    "rtspRegion": "cn-shanghai",
    "recordTypeList": [
        0,
        1,
        2,
        3
    ],
    "waitingRoomModeList": [
        0,
        1,
        2
    ],
    "rtmpLayout": 1,
    "rtmpRichTextRemark": "3213213123123",
    "rtmpWatchPwd": "0091",
    "rtmpWatchLimitType": 1,
    "enableOwnLive": true
}

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.yealink.com/open/api/v2/vmrs/147d94feddaf4d4f85dbb773f196b703'
本页目录