查询会议布局列表

最近更新时间:2024-07-08 11:48:53

我的收藏

接口描述

描述:根据会议 ID 返回会议布局列表信息,目前暂不支持 OAuth2.0 鉴权访问。
请求方式:GET
接口请求域名
https://api.meeting.qq.com/v1/meetings/{meeting_id}/layouts?userid={userid}&instanceid={instanceid}


输入参数

HTTP 请求头公共参数请参见签名验证章节的 公共参数说明
参数名称
必选
参数类型
参数描述
meeting_id
String
会议 ID。
userid
String
会议创建者 ID。
instanceid
Integer
用户的终端设备类型:
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

输出参数

参数名称
参数类型
参数描述
layout_number
Integer
布局数量。
selected_layout_id
String
会议应用的布局 ID。
layout_list
LayoutList 对象数组
布局对象列表。

LayoutList 对象

参数名称
参数类型
参数描述
layout_id
String
布局 ID。
page_list
PageList 对象数组
布局单页对象列表。

PageList 对象

参数名称
参数类型
参数描述
layout_template_id
String
布局模板 ID。
user_seat_list
UserSeatList 对象数组
用户座次对象列表。

UserSeatList 对象

参数名称
参数类型
参数描述
grid_id
String
宫格 ID。
grid_type
Integer
宫格类型:
1:视频画面(此类型需传递 userid 或 uuid、username 入参,作为视频画面展示;若会中参会成员有外部企业用户,需传递该用户的 uuid;如果 userid、uuid 同时传递则以 uuid 为准)。
2:共享画面。
3:拓展应用(目前一页仅可添加一个应用)
userid
String
用户 ID。
uuid
String
用户身份 ID(腾讯会议颁发的用于开放平台的唯一用户 ID)。
username
String
用户昵称。
ms_open_id
String
当场会议的用户临时 ID。
tool_sdkid
String
拓展应用 ID。

错误码列表

状态码
错误码
错误描述
400
190004
参数非法,请对照接口文档检查您的参数。
500
9042
没有权限。
500
190001
存在未注册的用户。
500
202001
会议明细获取失败,请检查会议是否存在。

示例

输入示例

GET
https://api.meeting.qq.com/v1/meetings/6524541286408448530/layouts?userid=creator1&instanceid=1

输出示例

{
"layout_number":1,
"selected_layout_id":"03acdd90-b0b2-41dd-8484-648f3d284070",
"layout_list":[
{
"layout_id":"03acdd90-b0b2-41dd-8484-648f3d284070",
"page_list":[
{
"layout_template_id":"1",
"user_seat_list":[
{
"grid_id":"10",
"grid_type":1,
"userid":"invitee1",
"uuid":"WM4Fxxxxxxxxxx3JiK",
"username":"joker",
"ms_open_id": "68+lhnxxxxxxxxxxxxxxxxhqQC7o4kFb3xxxxxxxxxxxxh+tJ3+j2xkYT1"
},
{
"grid_id":"1",
"grid_type":1,
"userid":"invitee2",
"uuid":"BL76xxxxxxxxxxFn11",
"username":"batman",
"ms_open_id": "68+lhnxxxxxxxxxxxxxxxx3B7r9o3h7f2xxxxxxxxxxxxl+tH2+l3wDQR3"
}
]
}
]
}
]
}