企业内部开发
基础
连接微信
办公
会议
会议统计管理
企业内部开发
服务端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_tokenstring调用接口凭证。获取方法查看“获取access_token
meetingidstring会议 ID
layout_listobject[]布局对象列表,详见LayoutRequest
default_layout_orderuint32布局列表中会议需要应用的布局序号,从1开始计数(首次添加时若该参数不送,则默认选中第一个布局作为会议应用的布局)

LayoutRequest 说明

参数必须类型说明
page_listobject[]布局单页对象列表,详见LayoutPageRequest

LayoutPageRequest 说明

参数必须类型说明
layout_template_idstring布局模板 ID
user_seat_listobject[]用户座次对象列表,详见UserSeatRequest

UserSeatRequest 说明

参数必须类型说明
grid_idstring宫格 ID。若多次传入同一宫格ID的对象,仅第一次出现的对象生效。
grid_typeuint32宫格类型:
1. 视频画面
2. 共享画面
3. 拓展应用(目前一页仅可添加一个应用)。添加的应用需满足以下条件:1) 与会议绑定。2) 开启网页服务。3) 同企业下的仅企业内可见应用或外部企业可见应用。
useridstring当场会议的企业成员的userid
tmp_openidstring当场会议的用户临时 ID
nick_namestring当宫格类型(grid_type)为1时必填,作为视频画面展示
tool_sdkidstring拓展应用 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"
			}]
		}]
	}]
}

参数说明:

参数类型说明
errcodeint32返回码
errmsgstring对返回码的文本描述内容
selected_layout_idstring会议应用的布局 ID
layout_listobject[]布局对象列表,详见LayoutResponse

LayoutResponse 说明

参数类型说明
page_listobject[]布局单页对象列表,详见LayoutPageResponse
layout_idstring布局 ID

LayoutPageResponse 说明

参数类型说明
layout_template_idstring布局模板 ID
user_seat_listobject[]用户座次对象列表,详见UserSeatResponse

UserSeatResponse 说明

参数类型说明
grid_idstring宫格 ID
grid_typeuint32宫格类型:
1. 视频画面
2. 共享画面
3. 拓展应用
useridstring当场会议的企业成员的userid
tmp_openidstring当场会议的用户临时 ID
nick_namestring当宫格类型(grid_type)为1时必填,作为视频画面展示
tool_sdkidstring拓展应用 ID
上一篇获取布局模板列表
下一篇添加会议高级布局
    本节内容
服务端API
基础
连接微信
办公
会议
会议统计管理
客户端API
小程序
基础
连接微信
办公
WECOM-JSSDK
JS-SDK
基础
连接微信
办公
更新日志
联系我们