企业内部开发
基础
连接微信
办公
会议
会议统计管理
企业内部开发
服务端API
会议
会议布局和背景管理
获取用户布局
获取用户布局
最后更新:2023/05/31

根据会议 ID 和用户 ID 返回用户的布局设置信息。
布局优先级:用户个性布局 > 会议自定义布局(高级布局、基础布局)> 会议默认布局。

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

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

请求包体:

{
	"meetingid": "MEETINGID",
	"tmp_openid": "TMPOPENID1",
	"instance_id": 1
}

参数说明:

参数必须类型说明
access_tokenstring调用接口凭证。获取方法查看“获取access_token
meetingidstring会议 ID
tmp_openidstring被操作用户临时身份 ID
instance_iduint32被操作用户终端设备类型 ID:
0:PSTN
1:PC
2:Mac
3:Android
4:iOS
5:Web
6:iPad
7:Android Pad
8:小程序
9:voip、sip 设备
10:linux
20:Rooms for Touch Windows
21:Rooms for Touch MacOS
22:Rooms for Touch Android
30:Controller for Touch Windows
32:Controller for Touch Android
33:Controller for Touch iOS

返回结果:

{
	"errcode": 0,
	"errmsg": "ok",
	"selected_layout_id": "LAYOUTID1",
	"layout_name": "testmictest",
	"layout_type": 2,
	"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": [{
                    "tmp_openid": "TMPOPENID1"
                }]
            }]
    }]
}

参数说明:

参数类型说明
errcodeint32返回码
errmsgstring对返回码的文本描述内容
selected_layout_idstring会议应用的布局 ID
layout_namestring布局名称
layout_typeuint32布局类型:
0:默认布局
2:自定义会议布局
3:个性布局
page_listobject[]布局单页对象列表,详见LayoutPage

LayoutPage 说明

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

PollingSetting 说明

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

UserSeat 说明

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

GridUser 说明

参数类型说明
tmp_openidstring用户当前会议临时身份 ID,单场会议唯一
上一篇获取会议布局列表
下一篇批量删除布局
    本节内容
服务端API
基础
连接微信
办公
会议
会议统计管理
客户端API
小程序
基础
连接微信
办公
WECOM-JSSDK
JS-SDK
基础
连接微信
办公
更新日志
联系我们