接口描述
描述:
对成功预定的会议添加会议布局,支持多个布局的添加,每个布局支持多页模板,默认选中第一页模板作为该布局的首页进行展示。
用户座次设置区分会前和会中两种方式:会前只允许设置邀请者成员,会中只允许设置参会成员。
一场会议最多添加20个布局,添加成功返回新增的会议布局信息。
目前暂不支持 OAuth2.0 鉴权访问。
请求方式:POST
接口请求域名:
https://api.meeting.qq.com/v1/meetings/{meeting_id}/layouts
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
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 |
default_layout_order | 否 | Integer | 布局列表中会议需要应用的布局序号,从1开始计数(首次添加时若该参数不传送,则默认选中第一个布局作为会议应用的布局)。 |
layout_list | 是 | LayoutList 对象数组 | 布局对象列表。 |
LayoutList 对象
参数名称 | 必选 | 参数类型 | 参数描述 |
page_list | 是 | PageList 对象数组 | 布局单页对象列表。 |
PageList 对象数组对象
参数名称 | 必选 | 参数类型 | 参数描述 |
layout_template_id | 是 | String | 布局模板 ID。 |
user_seat_list | 否 | UserSeatList 对象数组 | 用户座次对象列表。 |
UserSeatList 对象数组
参数名称 | 必选 | 参数类型 | 参数描述 |
grid_id | 是 | String | 宫格 ID。 |
grid_type | 是 | Integer | 注意:多次传入同一宫格 ID 的对象,仅第一次出现的对象生效。 宫格类型: 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。 |
输出参数
参数名称 | 参数类型 | 参数描述 |
layout_number | Integer | 布局数量。 |
selected_layout_id | String | 会议应用的布局 ID。 |
layout_list | LayoutList 对象数组 | 布局对象列表。 |
LayoutList 对象
参数名称 | 参数类型 | 参数描述 |
layout_id | String | 布局 ID。 |
page_list | 布局单页对象数组 | 布局单页对象列表。 |
布局单页对象
布局单页对象与输入参数完全相同。
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 20020 | 会中非参会成员不得设置座次。 |
400 | 20010 | 会议布局数量超过最大值。 |
500 | 9042 | 没有权限。 |
500 | 190001 | 存在未注册的用户。 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
500 | 202004 | OAuth 鉴权时查询 secret 信息失败。 |
400 | 20028 | 不存在的布局宫格 ID。 |
400 | 20027 | 不存在的布局模板 ID。 |
400 | 20025 | 应用布局序号超出范围。 |
500 | 202001 | 会议明细获取失败,请检查会议是否存在。 |
400 | 20011 | 会前非邀请成员不得设置座次。 |
示例
输入示例
POSThttps://api.meeting.qq.com/v1/meetings/6524541286408448530/layouts{"userid":"creator1","instanceid":1,"layout_list":[{"page_list":[{"layout_template_id":"1","user_seat_list":[{"grid_id":"10","grid_type":1,"userid":"invitee1","username":"joker","ms_open_id": "68+lhnxxxxxxxxxxxxxxxxhqQC7o4kFb3xxxxxxxxxxxxh+tJ3+j2xkYT1"}]}]}]}
输出示例
{"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","username":"joker","ms_open_id": "68+lhnxxxxxxxxxxxxxxxxhqQC7o4kFb3xxxxxxxxxxxxh+tJ3+j2xkYT1"}]}]}]}