文档帮助平台
首页服务端API参考 云会议室管理 添加云会议室
添加云会议室
更新时间：2025-09-18 02:39:11

添加云会议室

请求方法

POST

请求地址

/vmrs

请求参数

参数 参数类型 数据类型 是否必须 参数说明
name Body String 是 云会议室名称，长度小于256
extension Body String 否 会议短号，必须符合企业号码段规则，默认5位数字，最小长度4，最大长度10，若为空，按企业号码段规则随机生成
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模式
enableRtmp Body Boolean 否 是否启用RTMP，默认false
enableWaitingRoom Body Boolean 否 是否启用会议等候室，默认false
waitingRoomMode Body Integer 否 会议等候室设置，可选值：0=企业内所有人；1=仅主持人；2=企业内所有人及受邀参会者；3=仅受邀参会者，默认为3
enableJoinForwardModerator Body Boolean 否 是否允许在主持人之前加入，默认为true
enableOnlyLoginUserJoin Body Boolean 否 是否启用仅登录用户入会，默认false
enableWatermark Body Boolean 否 是否启用会议水印水印，默认false
watermarkTransparency Body Integer 否 水印透明度，0：浅；1：中；2：深
watermarkFontSize Body Integer 否 水印文字大小，0：小；1：中；2：大
enableScreenShareWatermark Body Boolean 否 是否启用屏幕共享水印，默认false（已废弃，建议使用enableWatermark参数）
enableJoinAutoMute Body Boolean 否 入会自动静音，默认false
speakMode Body Integer 否 发言模式。0，自由发言；1，申请发言，默认为0
voicePromptMode Body Integer 否 入会与离会提示音，0：不开启；1：仅入会方接收提示音；2：仅入会方和主持人接收提示音；3：所有参会方接收提示音。默认1：仅入会方接收提示音
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
rtmpLayout Body Integer 否 网络直播布局，可选值：1：演讲者模式，2：单方全屏模式，默认为1
enableCloudRecording Body Boolean 否 是否启用云端录制，默认为true
enableAutoRecord Body Boolean 否 是否开启云端自动录制，默认false
recordTypeList Body List<Integer> 否 录制方式，可选值：0：录制视频和音频，1：独立录制辅流，2：独立录制音频，3：录制发言者，必选值：0，默认[0]
recordLayout Body Integer 否 云端录制布局，可选值：1：演讲者模式，2：画中画模式，3：等分布局，默认为1
enableHostKey Body Boolean 否 是否启用主持人秘钥，默认为false
hostKey Body String 否 主持人秘钥，必须为纯数字，最小长度4，最大长度12，当开启主持人秘钥时，必填

Participant对象定义

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

HTTP状态码

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

响应参数

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

请求消息示例

POST /v2/vmrs HTTP/1.1
Host: api.ylyun.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,
    "enableHostKey": true,
    "hostKey": "123456",
    "voicePromptMode": 0
}

响应消息示例

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}' 'https://api.ylyun.com/v2/vmrs'
本页目录