修改单个布局

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

我的收藏

基本信息

接口描述:
对会议中的布局进行修改,注意修改的是布局定义。
若修改的会议布局正被会议使用,新布局会自动应用到会议。
若修改的布局为会议为成员指定的布局,则会修改失败。
接口仅支持全量更新,不支持部分字段单独更新。
目前暂不支持 OAuth2.0 鉴权访问。
请求方式: PUT
接口请求域名:
https://api.meeting.qq.com/v1/meetings/{meeting_id}/advanced-layouts/{layout_id}


输入参数

参数名称
必选
参数类型
参数描述
meeting_id
String
会议 ID。
layout_id
String
要修改的布局 ID。
operator_id
String
操作人 ID。
operator_id_type
Integer
操作人 ID 类型。
1:userid
4:ms_open_id
instanceid
Integer
用户的终端设备类型:
0:PSTN
1:PC
2:Mac
3:Android
4:iOS
5:Web
6:iPad
7:Android Pad
8:小程序
9:voip、sip 设备
10:Linux
20:Rooms for Touch Windows
21:Rooms for Touch MacOS
22:Rooms for Touch Android
30:Controller for Touch Windows
32:Controller for Touch Android
33:Controller for Touch iOS
layout_name
String
布局名称。
page_list
PageList 对象数组
布局单页对象列表。

PageList 对象

参数名称
必选
参数类型
参数描述
layout_template_id
String
布局模板 ID。
enable_polling
Boolean
开启或关闭轮询,默认关闭。
polling_setting
PollingSetting 对象
轮询参数设置对象。
user_seat_list
UserSeatList 对象数组
用户座次对象列表。

PollingSetting 对象

参数名称
必选
参数类型
参数描述
polling_interval_unit
Integer
轮询开启后设置参数。轮询间隔时间类型:
1:秒
2:分钟
polling_interval
Integer
轮询开启后设置参数。
轮询间隔时长,允许取值范围1~999999。
ignore_user_novideo
Boolean
轮询开启后设置参数,设置是否忽略没开启视频成员。
ignore_user_absence
String
轮询开启后设置参数,设置是否忽略未入会成员。

UserSeatList 对象

参数名称
必选
参数类型
参数描述
grid_id
String
宫格 ID。
grid_type
Integer
宫格类型:
1:视频画面
2:共享画面
video_type
Integer
视频画面来源:
1:演讲者
2:自动填充
3:指定人员
根据 user_list 的定义显示视频内容(此类型需传递 userid 或 ms_open_id、username 入参,作为视频画面展示;若会中参会成员有外部企业用户,需传递该用户的 ms_open_id;如果 userid、ms_open_id 同时传递则以 ms_open_id 为准)
user_list
UserList 对象数组
宫格中的用户列表:
轮询关闭,只有一个用户。
轮询开启后,可以包含多个用户。

UserList 对象

参数名称
必选
参数类型
参数描述
userid
String
用户 ID,userid 与 ms_open_id 至少传一个。
ms_open_id
String
用户当前会议临时身份 ID,单场会议唯一。userid 与 ms_open_id 至少传一个。
username
String
用户昵称,base64 编码。

错误码列表

状态码
错误码
错误描述
500
9042
没有权限。
400
190004
参数非法,请对照接口文档检查您的参数。
400
20020
会中非参会成员不得设置座次。
400
20028
不存在的布局宫格 ID。
400
20012
不存在的布局 ID。
400
20011
会前非邀请成员不得设置座次。
500
190001
存在未注册的用户。
500
202001
会议明细获取失败,请检查会议是否存在。

示例

输入示例

{
"operator_id": "test_restapi_user_597",
"operator_id_type": 1,
"instanceid": 2,
"page_list": [{
"layout_template_id": "3",
"enable_polling": true,
"polling_setting": {
"polling_interval_unit": 1,
"polling_interval": 10,
"ignore_user_novideo": true,
"ignore_user_absence": false
},
"user_seat_list": [{
"grid_id": "1",
"grid_type": 1,
"video_type": 3,
"user_list": [{
"userid": "test_restapi_user_598",
"username": "test_restapi_user_598"
}, {
"userid": "test_restapi_user_599",
"username": "test_restapi_user_599"
}]
}]
}]
}

输出示例

{}