文档帮助平台
首页服务端API参考 云会议室管理 添加云会议室
添加云会议室
更新时间：2025-09-08 20:40:43

添加云会议室

请求方法

POST

请求地址

/vmrs

请求参数

参数 参数类型 数据类型 是否必须 参数说明
name Body String 是 云会议室名称，长度小于256
extension Body String 是 会议短号，必须符合企业号码段规则，默认5位数字，最小长度4
groupId Body String 否 分组id，长度32，默认添加到根目录下
password Body String 否 会议密码,6位数字，若为空则无密码
syncDirectory Body Boolean 否 是否同步地址簿，默认false
participants Body Participant[] 否 参会者信息，若为空，默认企业管理员作为参会者
defaultLayout Body Integer 否 默认布局。1，1+N模式；2，等分模式。默认1，1+N模式
enableJoinAutoMute Body Boolean 否 入会自动静音，默认false
enableAutoRecord Body Boolean 否 自动录制，默认false
voicePromptMode Body Integer 否 入会与离会提示音，0：无提示；1：仅入会方接收提示音；2：仅入会方和主持人接收提示音；3：所有参会方接收提示音。默认1：仅入会方接收提示音
enableRtmp Body Boolean 否 是否启用RTMP，默认false
enableShowRoomName Body Boolean 否 第三方终端设置，是否显示会场名称，默认true
enableShowRoomStateIcon Body Boolean 否 第三方终端设置，是否显示会场状态，默认true
attendeesDefaultLayout Body Integer 否 与会者入会默认布局，可选值：1：演讲者，2：画中画，默认为1
maxBandwidth Body String 否 最大呼叫带宽，可选值：128Kbps,521Kbps,768Kbps,1Mbps,1.5Mbps,2Mbps,3Mbps,4Mbps,6Mbps,8Mbps,10Mbps 默认跟随企业会议设置
maxSecondaryFlowResolution Body String 否 最大辅流分辨率，可选值：4K/30FPS,1080P/60FPS,1080P/30FPS,720P/30FPS,360P/30FPS 默认跟随企业会议设置
maxVideoResolution Body String 否 最大视频分辨率，可选值：4K/30FPS,1080P/60FPS,1080P/30FPS,720P/30FPS,360P/30FPS 默认跟随企业会议设置
enableWaitingRoom Body Boolean 否 是否启用会议等候室 默认跟随企业会议设置
~~waitingRoomMode~~ Body Integer 否 已废弃，，支持旧版本兼容,请使用waitingRoomModeList这个字段。会议等候室设置，可选值：0=企业内所有人；1=仅主持人；2=企业内所有人及受邀参会者；3=仅受邀参会者 默认跟随企业会议设置
profile Body Integer 否 会议模式 0：视频会议模式； 2：研讨会模式； 3：语音会议模式 ，默认为 0
enableJoinForwardModerator Body Boolean 否 是否允许在主持人之前加入，默认true
~~enableScreenShareWatermark~~ Body Boolean 否 已废弃,支持旧版本兼容,请使用enableWatermark字段。是否启用屏幕共享水印，默认false （启用需先开启仅登录用户入会）
enableWatermark Body Boolean 否 是否启用水印,默认false（启用需先开启仅登录用户入会）
watermarkTransparency Body Integer 否 水印透明度，0：浅；1：中；2：深，默认为1
watermarkFontSize Body Integer 否 水印文字大小，0：小；1：中；2：大，默认为1
enableOnlyLoginUserJoin Body Boolean 否 是否启用仅登录用户入会，默认false（关闭“仅登录用户入会”时需同步关闭水印）
speakMode Body Integer 否 发言模式。0，自由发言；1，申请发言，默认0
enableUniqueParticipantResidenceTime Body Boolean 否 允许设置仅一个与会者停留时自动结束会议时间 ，默认false
enableNoModeratorTime Body Boolean 否 允许设置无主持人自动结束会议 ，默认false
chatPermissionsByAttendees Body Integer 否 聊天权限-与会者，可选值：0：允许群聊和私聊，1：仅允许群聊，2：仅允许私聊主持人，3：全体成员禁言，默认为0
sharePermissions Body Integer 否 共享权限，可选值：0：所有参会者，1：仅主持人可共享，默认为0
annotationPermissions Body Integer 否 批注权限，可选值：0：所有参会者，1：仅共享者和主持人，默认为0
enableRenamePermissions Body Boolean 否 是否启用改名权限，默认为true
enableUnmuteRequiresUserConsent Body Boolean 否 是否启用解除静音需用户同意，默认为false
enableOpenVideoRequiresUserConsent Body Boolean 否 是否开启视频需要用户同意，默认为false
enableChatHistoryExport Body Boolean 否 是否允许聊天记录导出，默认为true
recordTypeList Body Integer[] 否 录制方式，可选值：0：录制视频和音频，1：录制独立辅流，2：录制独立音频，3：录制发言者，可多选 ，默认为 [0]
rtmpLayout Body Integer 否 网络直播布局，可选值：1：演讲者模式，2：画中画模式，默认为1
waitingRoomModeList Body Integer[] 否 会议等候室设置（新），可选值：0=开启企业内所有人；1=开启受邀参会者；2=开启第三方入会Ip白名单 默认跟随企业会议设置。对于只传递字段waitingRoomMode的场景，已做兼容处理。如果同时传递字段waitingRoomMode和字段waitingRoomModeList，则取字段waitingRoomModeList的值。
enableRtsp Body Boolean 否 是否开启RTSP推流功能，默认不开启
rtspLiveVideoResolution Body String 否 推流分辨率，默认跟随企业设置，可选值：4K/30FPS、1080P/30FPS、720P/30FPS
rtspPushLayout Body Integer 否 推流布局，默认跟随企业设置，可选值：1，演讲者模式；2，画中画模式；
rtspPushUrlType Body Integer 否 推流地址类型，默认跟随企业设置，可选值：0，固定；1，随机；
rtspRegion Body String 否 RTSP直播下沉区域，非必填，不传默认为中心节点，如 “cn-shanghai”
rtmpWatchPwd Body String 否 直播密码，密码长度为4位。设置直播密码时,rtmpWatchLimitType的值应设置为1
rtmpRichTextRemark Body String 否 直播介绍
rtmpWatchLimitType Body Integer 否 直播观看限制类型，0：所有人，1：需要密码. 不传递，默认为0
enableOwnLive Body Boolean 否 是否启用自有直播，默认为false

Participant对象定义

参数 参数类型 数据类型 是否必需 描述
participantId Body String 是 人员id，长度32
participantRole Body Integer 是 人员角色，0：组织者（仅用户），1：主持人（仅用户或硬件终端），2：参会者

HTTP状态码

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

响应参数

参数 数据类型 描述
id String vmr Id

请求消息示例

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

{
    "name": "test",
    "groupId": "452ae18eb3164c999d197f97f9d4fd72",
    "extension": "12345",
    "syncDirectory": true,
    "enableRtmp": false,
    "enableAutoRecord": false,
    "participants": [
        {
            "participantId": "64bb26c0065b4a54b0dd659e365e93b9",
            "participantRole": 0
        }
    ],
    "enableJoinAutoMute": false,
    "defaultLayout": 1,
    "voicePromptMode": 0,
    "enableWaitingRoom": false,
    "attendeesDefaultLayout": 1,
    "password": null,
    "enableShowRoomName": true,
    "enableShowRoomStateIcon": true,
    "maxVideoResolution": "1080P/30FPS",
    "maxSecondaryFlowResolution": "1080P/30FPS",
    "maxBandwidth": "3Mbps",
    "waitingRoomMode": 3,
    "profile": 0,
    "enableJoinForwardModerator": true,
    "enableScreenShareWatermark": false,
    "enableWatermark": true,
    "watermarkTransparency": 1, 
    "watermarkFontSize": 1,  
    "enableOnlyLoginUserJoin": true,
    "speakMode": 0,
    "enableUniqueParticipantResidenceTime": true,
    "enableNoModeratorTime": true,
    "chatPermissionsByAttendees": 0,
    "sharePermissions": 0,
    "annotationPermissions": 0,
    "enableRenamePermissions": true,
    "enableUnmuteRequiresUserConsent": true,
    "enableOpenVideoRequiresUserConsent": true,
    "enableChatHistoryExport": true,
    "recordTypeList": [
        0,
        1,
        2,
        3
    ],
    "rtmpLayout": 1
}

响应消息示例

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

{
	"id":"eeba0323e2ed44e6be6a7cc61efb6130"
}

CURL命令示例

curl -XPOST  -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJwc3QiOjAsImFyZWEiOiJDTi1GSiIsImNvdW50cnkiOiJDTiIsImN0IjoxLCJzIjo1NCwiZXgiOjE1ODMxMTc3MzMxNzMsInQiOiJvIiwiY2kiOiIxZGU3MzA4YzZlYzM0YmZlODY5OWY0ZmQ0ZjZlMWE4MyIsInBpZCI6IjE5MmI4NmM4MzNhMDQ5OGFiNWU5NTgwMGE0YWMxOWU4IiwianRpIjoiMTkwYzljMDgxMzA2NDQ3M2IxZTI0MDY4YzE1OWFmOWEifQ.UPbzEA5i4To9SAWXor-KU835cBaRp3Ws_aZI6MHIrcqy8l2BSXz_XdgiGU5D3Cv0QwF7Bt9oWScNOspk4AbWVRTtYMhQfsVuemwBHD7BVth3UiBJDyScl-kcoQ_2vajUlv-pglcCQtNLfPyzH6Dk1gKzcrMSmYRKtIjqNyuFOmg' -H 'Content-Type: application/json' -H 'timestamp: 1583742732181' -H 'nonce: 53f0765fadb54fb6b002f3baac2d5ec8'  -d '{"name":"test","groupId":"452ae18eb3164c999d197f97f9d4fd72","extension":"10001","syncDirectory":true,"enableRtmp":false,"enableAutoRecord":false,"participants":[{"participantId":"64bb26c0065b4a54b0dd659e365e93b9","participantRole":0}],"enableJoinAutoMute":false,"defaultLayout":1,"voicePromptMode":0,"enableWaitingRoom":false,"attendeesDefaultLayout": 1,"password": null,"enableShowRoomName": true,"enableShowRoomStateIcon": true,"maxVideoResolution": "1080P/30FPS","maxSecondaryFlowResolution": "1080P/30FPS","maxBandwidth": "3Mbps","waitingRoomMode":3,"profile": 0,"enableJoinForwardModerator": true,"enableScreenShareWatermark": true,"enableOnlyLoginUserJoin": true,"speakMode": 0,"enableUniqueParticipantResidenceTime": true,"enableNoModeratorTime": true,"chatPermissionsByAttendees": 0,"sharePermissions": 0,"annotationPermissions": 0,"enableRenamePermissions": true,"enableUnmuteRequiresUserConsent": true,"enableOpenVideoRequiresUserConsent": true,"enableChatHistoryExport": true,"recordTypeList": [0,1,2,3],"rtmpLayout": 1}' 'https://api.yealink.com/open/api/v2/vmrs'
本页目录