添加会议基础布局 - 接口文档 - 企业微信开发者中心

开发者中心

首页

教程

接口

社区

工具

企业内部开发

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

企业内部开发服务端API 会议会议布局和背景管理添加会议基础布局

添加会议基础布局

最后更新：2023/05/31

对API成功预定的会议添加会议基础布局，支持多个布局的添加，每个布局支持多页模板，默认选中第一页模板作为该布局的首页进行展示。
用户座次设置区分会前和会中两种方式：会前只允许设置邀请者成员，会中只允许设置参会成员。
一场会议最多添加10个布局，添加成功返回新增的会议布局信息。

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

请求包体：

{
	"meetingid": "MEETINGID",
	"layout_list": [{
		"page_list":[{
			"layout_template_id": "TEMID1",
			"user_seat_list":[{
				"grid_id":"10",
				"grid_type":1,
				"userid": "USERID",
				"tmp_openid": "68j2xkYT1",
				"nick_name": "NICK",
				"tool_sdkid": "SDKID"
			}]
		}]
	}],
	"default_layout_order": 1
}

参数说明：

参数	必须	类型	说明
access_token	是	string	调用接口凭证。获取方法查看“获取access_token”
meetingid	是	string	会议 ID
layout_list	是	object[]	布局对象列表，详见LayoutRequest
default_layout_order	否	uint32	布局列表中会议需要应用的布局序号，从1开始计数（首次添加时若该参数不送，则默认选中第一个布局作为会议应用的布局）

LayoutRequest 说明

参数	必须	类型	说明
page_list	是	object[]	布局单页对象列表，详见LayoutPageRequest

LayoutPageRequest 说明

参数	必须	类型	说明
layout_template_id	是	string	布局模板 ID
user_seat_list	否	object[]	用户座次对象列表，详见UserSeatRequest

UserSeatRequest 说明

参数	必须	类型	说明
grid_id	是	string	宫格 ID。若多次传入同一宫格ID的对象，仅第一次出现的对象生效。
grid_type	是	uint32	宫格类型： 1. 视频画面 2. 共享画面 3. 拓展应用（目前一页仅可添加一个应用）。添加的应用需满足以下条件：1) 与会议绑定。2) 开启网页服务。3) 同企业下的仅企业内可见应用或外部企业可见应用。
userid	否	string	当场会议的企业成员的userid
tmp_openid	否	string	当场会议的用户临时 ID
nick_name	否	string	当宫格类型(grid_type)为1时必填，作为视频画面展示
tool_sdkid	否	string	拓展应用 ID

userid, tmp_openid, tool_sdkid 三者填其一

返回结果：

{
	"errcode": 0,
	"errmsg": "ok",
	"selected_layout_id": "LAYOUTID1",
	"layout_list": [{
		"layout_id": "LAYOUTID1",
		"page_list": [{
			"layout_template_id": "TEMID1",
			"user_seat_list":[{
				"grid_id":"10",
				"grid_type":1,
				"userid": "USERID",
				"tmp_openid": "68j2xkYT1",
				"nick_name": "NICK",
				"tool_sdkid": "SDKID"
			}]
		}]
	}]
}

参数说明：

参数	类型	说明
errcode	int32	返回码
errmsg	string	对返回码的文本描述内容
selected_layout_id	string	会议应用的布局 ID
layout_list	object[]	布局对象列表，详见LayoutResponse

LayoutResponse 说明

参数	类型	说明
page_list	object[]	布局单页对象列表，详见LayoutPageResponse
layout_id	string	布局 ID

LayoutPageResponse 说明

参数	类型	说明
layout_template_id	string	布局模板 ID
user_seat_list	object[]	用户座次对象列表，详见UserSeatResponse

UserSeatResponse 说明

参数	类型	说明
grid_id	string	宫格 ID
grid_type	uint32	宫格类型： 1. 视频画面 2. 共享画面 3. 拓展应用
userid	string	当场会议的企业成员的userid
tmp_openid	string	当场会议的用户临时 ID
nick_name	string	当宫格类型(grid_type)为1时必填，作为视频画面展示
tool_sdkid	string	拓展应用 ID

获取布局模板列表

添加会议高级布局

本节内容

添加会议基础布局