接口描述
描述:根据会议 ID 返回会议的布局定义信息列表,目前暂不支持 OAuth2.0 鉴权访问。
请求方式: GET
接口请求域名:
https://api.meeting.qq.com/v1/meetings/{meeting_id}/advanced-layouts
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
meeting_id | 是 | String | 会议 ID。 |
请求参数
参数名称 | 必选 | 参数类型 | 参数描述 |
operator_id | 是 | String | 操作人 ID,该字段需 URLEncode。 |
operator_id_type | 是 | Integer | 操作人 ID 类型。 1:userid 4:ms_open_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 |
输出参数
参数名称 | 必选 | 参数类型 | 参数描述 |
selected_layout_id | 否 | String | 会议应用的布局 ID。 |
layout_list | 否 | Layout_List对象数组 | 布局对象列表。 |
Layout_List 对象
参数名称 | 必选 | 参数类型 | 参数描述 |
layout_id | 是 | String | 布局 ID。 |
layout_name | 否 | String | 布局名称。 |
layout_type | 是 | Integer | 布局类型: 1:基础自定义会议布局 2:高级自定义会议布局 |
page_list | 否 | Page_List 对象数组 | 布局单页对象列表。 |
Page_List 对象
参数名称 | 必选 | 参数类型 | 参数描述 |
layout_template_id | 是 | String | 布局模板 ID。 |
enable_polling | 是 | Boolean | 开启或关闭轮询,默认关闭。 |
polling_setting | 否 | PollingSetting 对象 | 轮询参数设置对象。 |
user_seat_list | 否 | UserSeatList 对象数组 | 用户座次对象列表。 |
PollingSetting 对象
参数名称 | 必选 | 参数类型 | 参数描述 |
polling_interval_unit | 是 | Integer | 轮询开启后设置参数。 轮询间隔时间类型: 1:秒 2:分钟 |
polling_interval | 是 | Integer | 轮询开启后设置参数。轮询间隔时长,允许取值范围1~999999。 |
ignore_user_novideo | 是 | Boolean | 轮询开启后设置参数,设置是否忽略没开启视频成员。 |
ignore_user_absence | 是 | String | 轮询开启后设置参数,设置是否忽略未入会成员。 |
UserSeatList 对象
参数名称 | 必选 | 参数类型 | 参数描述 |
grid_id | 是 | String | 宫格 ID。 |
grid_type | 是 | Integer | 宫格类型: 1:视频画面 2:共享画面 |
video_type | 否 | Integer | 视频画面来源: 1:演讲者 2:自动填充 3:指定人员 根据 user_list 的定义显示视频内容(此类型需传递 userid 或 ms_open_id、username 入参,作为视频画面展示;若会中参会成员有外部企业用户,需传递该用户的 ms_open_id;如果 userid、ms_open_id 同时传递则以 ms_open_id 为准) |
user_list | 否 | UserList 对象数组 | 宫格中的用户列表: 轮询关闭,只有一个用户。 轮询开启后,可以包含多个用户。 |
UserList 对象
参数名称 | 必选 | 参数类型 | 参数描述 |
userid | 否 | String | 用户 ID。 |
ms_open_id | 否 | String | 用户当前会议临时身份 ID,单场会议唯一。 |
username | 否 | String | 用户昵称,base64 编码。 |
示例
输入示例
GEThttps://api.meeting.qq.com/v1/meetings/13748123623500870961/advanced-layouts?operator_id=test_restapi_user_937&operator_id_type=1&instanceid=1
输出示例
{"selected_layout_id": "","layout_list": [{"layout_id": "04bcd40d-0c22-4527-a9e9-424716cd5f50","layout_name": "testmictest","layout_type": 2,"page_list": [{"layout_template_id": "3","enable_polling": true,"polling_setting": {"polling_interval": 10,"polling_interval_unit": 1,"ignore_user_absence": false,"ignore_user_novideo": false},"user_seat_list": [{"grid_id": "1","grid_type": 1,"video_type": 3,"user_list": [{"userid": "test_restapi_user_938","ms_open_id": "FL0TEoGDXWHiVLaNz7PWE2jfR/3eVXwaeOyteX1xuKmJoKQLqTHohwwNXSTwfPDhBEssx8nhLWJ3WJzsMhKfRw==","username": "test_restapi_user_938"}]}]}]}]}