修改会议高级布局 - 接口文档 - 企业微信开发者中心

开发者中心

首页

教程

接口

社区

工具

企业内部开发

快速入门服务端API 客户端API 附录更新日志联系我们

企业内部开发服务端API 会议会议布局和背景管理修改会议高级布局

修改会议高级布局

最后更新：2023/05/31

对会议中的高级布局进行修改，注意修改的是布局定义。
若修改的会议布局正被会议使用，新布局会自动应用到会议。
若修改的会议布局正在被用户使用，新布局不会自动应用到用户。
接口仅支持全量更新，不支持部分字段单独更新。

高级布局目前仅支持 H.323/SIP 会议室终端。

请求方式： POST（HTTPS）
请求地址： https://qyapi.weixin.qq.com/cgi-bin/meeting/advanced_layout/update?access_token=ACCESS_TOKEN

请求包体：

{
	"meetingid": "MEETINGID",
	"layout_id": "LAYOUTID1",
	"layout_name": "testmictest",
	"page_list": [{
		"layout_template_id": "3",
		"enable_polling": true,
		"polling_setting": {
			"polling_interval_unit": 1,
			"polling_interval": 10,
			"ignore_user_novideo": false,
			"ignore_user_absence": false
		},
		"user_seat_list": [{
			"grid_id": "1",
			"grid_type": 1,
			"video_type": 3,
			"user_list": [{
			    "userid": "USERID",
				"tmp_openid": "TMPOPENID1"
			}]
		}]
	}]
}

参数说明：

参数	必须	类型	说明
access_token	是	string	调用接口凭证。获取方法查看“获取access_token”
meetingid	是	string	会议 ID
layout_id	是	string	布局 ID
layout_name	否	string	布局名称
page_list	是	object[]	布局单页对象列表，详见LayoutPage

LayoutPage 说明

参数	必须	类型	说明
layout_template_id	是	string	布局模板 ID
enable_polling	是	bool	开启或关闭轮询，默认关闭
polling_setting	否	object	轮询参数设置对象，详见PollingSetting
user_seat_list	否	object[]	用户座次对象列表，详见UserSeat

PollingSetting 说明

参数	必须	类型	说明
polling_interval_unit	是	uint32	轮询开启后设置参数。轮询间隔时间类型： 1：秒 2：分钟
polling_interval	是	uint32	轮询开启后设置参数轮询间隔时长，允许取值范围1～999999
ignore_user_novideo	是	bool	轮询开启后设置参数，设置是否忽略没开启视频成员
ignore_user_absence	是	bool	轮询开启后设置参数，设置是否忽略未入会成员

UserSeat 说明

参数	必须	类型	说明
grid_id	是	string	宫格 ID
grid_type	是	uint32	宫格类型： 1. 视频画面 2. 共享画面
video_type	否	uint32	视频画面来源： 1：演讲者 2：自动填充 3：指定人员。根据 user_list 的定义显示视频内容（此类型需传递 tmp_openid）。
user_list	否	object[]	宫格中的用户列表：轮询关闭，只有一个用户；轮询开启后，可以包含多个用户。详见GridUser

GridUser 说明

参数	必须	类型	说明
userid	否	string	本场会议企业成员的userid。userid与tmp_openid必填其一
tmp_openid	否	string	用户当前会议临时身份 ID，单场会议唯一

返回结果：

{
	"errcode": 0,
	"errmsg": "ok"
}

参数说明：

参数	类型	说明
errcode	int32	返回码
errmsg	string	对返回码的文本描述内容

修改会议基础布局

设置会议默认布局

本节内容

修改会议高级布局