切换 MRA 默认布局

最近更新时间:2024-07-08 11:48:53

我的收藏

接口描述

描述:会议中对 MRA 的默认布局进行设置。如果当前 MRA 已显示会议自定义布局或个性布局或焦点视频,则不支持进行默认布局设置。
请求方式:PUT
接口请求域名
https://api.meeting.qq.com/v1/mra-control/meetings/{meetingId}/default-layout


输入参数

HTTP 请求头公共参数请参见签名验证章节的 公共参数说明

请求路径参数

参数名称
必选
参数类型
参数描述
meetingId
String
会议 ID,周期性会议传总会议 ID。

请求 body

参数名称
必选
参数类型
参数描述
operator_id
String
操作者 ID。
operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。
operator_id_type
Integer
操作者 ID 的类型:
1:userid
4:ms_open_id
instanceid
Integer
用户的终端设备类型 ID。
default_layout
Integer
默认分屏设置:
1:等分模式
2:全屏模式
3:1+N
default_novideo_user
Integer
默认非视频与会者在分屏中显示方式:
1:显示
2: 隐藏
user
User 对象
被操作用户对象信息。

User 对象

参数名称
必选
参数类型
参数描述
ms_open_id
String
被操作 MRA 设置当前会议中的临时身份 ID。
instanceid
Integer
用户的终端设备类型:
9:voip、sip 设备

输出参数

成功返回空消息体,失败返回 错误码 和错误信息。

错误码列表

状态码
错误码
错误描述
400
9042
无权限进行该操作,建议检查操作者身份或资源归属。
400
190004
参数非法,请对照接口文档检查您的参数。
500
190001
存在未注册的用户。

示例

输入示例

PUT
https://api.meeting.qq.com/v1/mra-control/meetings/100001/default-layout
{
"operator_id":"user1",
"operator_id_type":1,
"instanceid":1,
"default_layout":1,
"default_novideo_user":1,
"user":{
"ms_open_id":"1234567",
"instanceid":9
}
}

输出示例

{}