接口描述

描述

  • 对成功预定的会议添加会议布局,支持多个布局的添加,每个布局支持多页模板,默认选中第一页模板作为该布局的首页进行展示。
  • 用户座次设置区分会前和会中两种方式:会前只允许设置邀请者成员;会中只允许设置参会成员。
  • 一场会议最多添加10个布局,添加成功返回新增的会议布局信息。
  • 目前暂不支持 OAuth2.0 鉴权访问。

调用方式:POST
接口请求域名

https://api.meeting.qq.com/v1/meetings/{meeting_id}/layouts

输入参数

HTTP 请求头公共参数请参见签名验证章节的 公共参数说明

参数名称 必选 参数类型 参数描述
meeting_id String 会议 ID。
userid String 会议创建者 ID。
instanceid Integer 设备类型 ID:<br>1:PC<br>2:Mac<br>3:Android<br>4:iOS<br>5:Web<br>6:iPad<br>7:Android Pad<br>8:小程序
default_layout_order Integer 布局列表中会议需要应用的布局序号,从1开始计数(首次添加时若该参数不送,则默认选中第一个布局作为会议应用的布局)。
layout_list 布局对象数组 布局对象列表。

布局对象

参数名称 必选 参数类型 参数描述
page_list 布局单页对象数组 布局单页对象列表。

布局单页对象

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

用户座次对象

参数名称 必选 参数类型 参数描述
grid_id String 宫格 ID。
grid_type Integer 宫格类型:<br>1. 视频画面(此类型需传递 userid 或 uuid、username 入参,作为视频画面展示;若会中参会成员有外部企业用户,需传递该用户的 uuid;如果 userid、uuid 同时传递则以 uuid 为准)。<br>2. 共享画面。
userid String 用户 ID。
uuid String 用户身份 ID(腾讯会议颁发的用于开放平台的唯一用户 ID)。
username String 用户昵称。

输出参数

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

布局对象

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

布局单页对象
布局单页对象与输入参数完全相同。

示例

输入示例

POST
https://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"
                        }
                    ]
                }
            ]
        }
    ]
}

输出示例

{
    "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"
                        }
                    ]
                }
            ]
        }
    ]
}
下载 添加会议布局.pdf
文章内容是否对您有帮助?
有帮助
无帮助