获取会议布局列表 - 接口文档 - 企业微信开发者中心

开发者中心

首页

教程

接口

社区

工具

企业内部开发

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

企业内部开发服务端API 会议会议布局和背景管理获取会议布局列表

获取会议布局列表

最后更新：2023/05/31

根据会议 ID 返回会议的基础和高级自定义布局信息列表。

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

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

请求包体：

{
	"meetingid": "MEETINGID"
}

参数说明：

参数	必须	类型	说明
access_token	是	string	调用接口凭证。获取方法查看“获取access_token”
meetingid	是	string	会议 ID

返回结果：

{
	"errcode": 0,
	"errmsg": "ok",
	"selected_layout_id": "LAYOUTID1",
	"layout_list": [{
        "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_absence": false,
                "ignore_user_novideo": false
            },
            "user_seat_list": [{
                "grid_id": "1",
                "grid_type": 1,
                "video_type": 3,
                "user_list": [{
					"userid": "USERID",
                    "tmp_openid": "TMPOPENID1",
					"nick_name": "dGVzdF9uaWNr"
                }]
            }]
        }]
    }]
}

参数说明：

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

Layout 说明

参数	类型	说明
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
tmp_openid	string	用户当前会议临时身份 ID，单场会议唯一
nick_name	string	用于视频画面展示的昵称(base64)

设置高级布局

获取用户布局

本节内容

获取会议布局列表