开发者中心
首页
教程
接口
社区
工具
企业内部开发
快速入门 服务端API 客户端API 附录 更新日志 联系我们
企业内部开发 服务端API 会议 会议布局和背景管理 添加会议高级布局
添加会议高级布局
最后更新：2023/05/31
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
添加会议高级布局
最后更新：2023/05/31

对当前会议添加高级布局，支持批量添加。
用户座次设置需设置参会成员。
单个会议最多允许添加20个高级布局。

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

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

请求包体：

{
	"meetingid": "MEETINGID",
	"layout_list": [{
        "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",
					"nick_name": "bmlja25hbWUK"
                }]
            }]
        }]
    }]
}

参数说明：

参数必须类型说明
access_token是string调用接口凭证。获取方法查看“获取access_token”
meetingid是string会议 ID
layout_list是object[]布局对象列表，详见LayoutRequest

LayoutRequest 说明

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

LayoutPageRequest 说明

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

PollingSettingRequest 说明

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

UserSeatRequest 说明

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

GridUser 说明

参数必须类型说明
userid否string本场会议企业成员的userid。userid与tmp_openid必填其一
tmp_openid否string用户当前会议临时身份 ID，单场会议唯一
nick_name否stringvideo_type为3时必填，用于视频画面展示，为base64编码。

返回结果：

{
	"errcode": 0,
	"errmsg": "ok",
	"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": "bmlja25hbWUK"
                }]
            }]
        }]
    }]
}

参数说明：

参数类型说明
errcodeint32返回码
errmsgstring对返回码的文本描述内容
layout_listobject[]布局对象列表，详见LayoutResponse

LayoutResponse 说明

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

LayoutPageResponse 说明

参数类型说明
layout_template_idstring布局模板 ID
enable_pollingbool开启或关闭轮询，默认关闭
polling_settingobject轮询参数设置对象，详见PollingSettingResponse
user_seat_listobject[]用户座次对象列表，详见UserSeatResponse

PollingSettingResponse 说明

参数类型说明
polling_interval_unituint32轮询开启后设置参数。轮询间隔时间类型：
1：秒
2：分钟
polling_intervaluint32轮询开启后设置参数 轮询间隔时长，允许取值范围1～999999
ignore_user_novideobool轮询开启后设置参数，设置是否忽略没开启视频成员
ignore_user_absencebool轮询开启后设置参数，设置是否忽略未入会成员

UserSeatResponse 说明

参数类型说明
grid_idstring宫格 ID
grid_typeuint32宫格类型：
1. 视频画面
2. 共享画面
video_typeuint32视频画面来源：
1：演讲者
2：自动填充
3：指定人员。根据 user_list 的定义显示视频内容。
user_listobject[]宫格中的用户列表：轮询关闭，只有一个用户；轮询开启后，可以包含多个用户。详见GridUser

GridUser 说明

参数类型说明
useridstring本场会议企业成员的userid
tmp_openidstring用户当前会议临时身份 ID，单场会议唯一
nick_namestringvideo_type为3时用于视频画面展示，为base64编码。
上一篇
添加会议基础布局
下一篇
修改会议基础布局