接口描述
描述:根据会议 ID 和用户 ID 返回用户的布局设置信息。布局优先级:用户个性布局 > 会议自定义布局(高级布局、基础布局)> 会议默认布局。目前暂不支持 OAuth2.0 鉴权访问。目前仅会应用于 H.323/SIP 终端。请求方式: GET接口请求域名:
https://api.meeting.qq.com/v1/meetings/{meeting_id}/applying-layout
输入参数
meeting_id |
是 |
String |
会议 ID。 |
operator_id |
是 |
String |
操作人 ID,该字段需 URLEncode。 |
operator_id_type |
是 |
Integer |
操作人 ID 类型。1:UserID4:MsOpenID |
instanceid |
是 |
Integer |
用户的终端设备类型:0:PSTN1:PC2:Mac3:Android4:iOS5:Web6:iPad7:Android Pad8:小程序9:voip、sip 设备10:Linux20:Rooms for Touch Windows21:Rooms for Touch MacOS22:Rooms for Touch Android30:Controller for Touch Windows32:Controller for Touch Android33:Controller for Touch iOS |
user_ms_open_id |
是 |
String |
被操作用户临时身份 ID,该字段需 UrlEncode。 |
user_instance_id |
是 |
Integer |
被操作用户设备类型 ID。 |
输出参数
selected_layout_id |
否 |
String |
用户当前应用的布局 ID。 |
layout_name |
否 |
String |
布局名称。 |
layout_type |
是 |
Integer |
布局类型: 0:默认布局。1:基础自定义会议布局。2:高级自定义会议布局。3:个性布局。 |
page_list |
否 |
PageList 对象数组 |
布局单页对象列表。 |
PageList 对象
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/177499xxxxxx843809/applying-layout?operator_id=test_restapi_user_401&operator_id_type=1&instanceid=1&user_ms_open_id=ADbYLpteGOCbXeNGfpijjsSlgpM041m0PtAhMJA%3D%3D&user_instance_id=9
输出示例
{ "selected_layout_id": "227xxxx-xxxx-xxxx-xxxx-xxxx8a7d9b3", "layout_name": "testmictest", "layout_type": 2, "page_list": [{ "layout_template_id": "3", "enable_polling": false, "user_seat_list": [{ "grid_id": "1", "grid_type": 2, "user_list": [{ "username": "5YWx5LqrxxxxZ2i" }] }] }]}
对腾讯办公协同的解决方案有疑惑?想了解解决方案收费? 联系解决方案专家
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心,购买腾讯云享受折上折,更有现金返利:同意关联,立享优惠
阿里云解决方案也看看?: 点击对比阿里云的解决方案