操作指南

API 文档

有奖调研

查询会议录制列表

最近更新时间:2021-11-24 11:13:25

接口描述

描述

  • 获取用户云录制记录,根据用户 ID、会议 ID、会议 code 进行查询,支持根据时间区间分页获取。
  • 企业 secret 鉴权用户可获取该用户所属企业下的会议录制列表,OAuth2.0 鉴权用户只能获取该企业下 OAuth2.0 应用的会议录制列表。
  • 当您想实时监测会议录制相关状况时,您可以通过订阅 录制管理 中的相关事件,接收事件通知。
  • 当前同一场会议的不同录制文件共用分享链接。

接口请求方法:GET
接口请求域名

https://api.meeting.qq.com/v1/records?page_size={page_size}&page={page}&meeting_id={meeting_id}&meeting_code={meeting_code}&userid={userid}&start_time={start_time}&end_time={end_time}

输入参数

以下请求参数列表仅列出了接口请求参数,HTTP 请求头公共参数请参见签名验证章节的 公共参数说明

参数名称 必选 参数类型 参数描述
operator_id String 操作者 ID。operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。
说明:userid 字段和 operator_id 字段二者必填一项。若两者都填,以 operator_id 字段为准。
operator_id_type Integer 操作者 ID 的类型:
3. rooms_id
说明:当前仅支持 rooms_id。如操作者为企业内 userid 或 openId,请使用 userid 字段。
userid String 用户 ID,当会议 ID 和会议 code 均为空时,表示查询用户所有会议的录制列表(企业内部请使用企业唯一用户标识;OAuth2.0 鉴权用户请使用 openId)。
企业唯一用户标识说明
1. 企业对接 SSO 时使用的员工唯一标识 ID;
2. 企业调用创建用户接口时传递的 userid 参数。 
meeting_id String 会议 ID,不为空时优先根据会议 ID 查询。
meeting_code String 会议 code,当 meeting_id 为空且 meeting_code 不为空时根据会议 code 查询。
start_time Number 查询起始时间戳,UNIX 时间戳(单位秒)。
说明:时间区间不允许超过31天。
end_time Number 查询结束时间戳,UNIX 时间戳(单位秒)。
说明:时间区间不允许超过31天。
page_size Integer 分页大小,默认值为10,最大为20。
page Integer 页码,从1开始,默认值为1。

输出参数

参数名称 必选 参数类型 参数描述
total_count Integer 分页查询返回数据总数。
current_size Integer 分页查询返回单页数据条数。
current_page Integer 分页查询返回当前页码。
total_page Integer 分页查询返回分页总数。
record_meetings Array 会议录制列表。

会议录制对象

参数名称 必选 参数类型 参数描述
meeting_record_id String 会议录制 ID。
meeting_id String 会议 ID。
meeting_code String 会议 code。
host_user_id String 主持人用户 ID。
media_start_time Number 会议开始时间,UNIX 时间戳(单位毫秒)。
subject String 会议主题。
state Integer 录制状态:
1:录制中
2:转码中
3:转码完成
当状态为转码完成才会返回录制文件列表。
record_files Array 录制文件列表。

录制文件对象

参数名称 必选 参数类型 参数描述
record_file_id String 录制文件 ID。
record_start_time Number 开始录制时间,UNIX 时间戳(单位毫秒)。
record_end_time Number 结束录制时间,UNIX 时间戳(单位毫秒)。
record_size Number 文件大小(单位字节)。
sharing_state Integer 共享状态,是否开启共享。
0:未开启
1:开启
当开启共享时返回访问权限、访问密码、共享链接有效期、是否允许下载。
sharing_url String 共享链接,开启共享时返回。
required_same_corp Bool 仅企业用户可查看,开启共享时返回。
required_participant Bool 仅参会成员可查看,开启共享时返回。
password String 访问密码,开启共享时返回。
sharing_expire Number 共享链接有效期(单位毫秒),当未开启共享时,返回0表示永久有效;开启共享时返回。
allow_download Bool 是否允许下载,开启共享时返回。

示例

输入示例

GET https://api.meeting.qq.com/v1/records?meeting_code=423111111&userid=testUser&start_time=1602950400&end_time=1603123200

输出示例

{
    "total_count":1,
    "current_size":10,
    "current_page":1,
    "total_page":1,
    "record_meetings":[
        {
            "meeting_record_id":"1318080818611111111",
            "meeting_id":"1360800130111111111",
            "meeting_code":"423111111",
            "host_user_id":"testUser",
            "media_start_time":1603089930093,
            "subject":"testUser的快速会议",
            "state":3,
            "record_files":[
                {
                    "record_file_id":1318080818611111111,
                    "record_start_time":1603089930577,
                    "record_end_time":1603089967213,
                    "record_size":604081,
                    "sharing_state":1,
                    "required_same_corp":false,
                    "required_participant":false,
                    "password":"cK3wAsfw",
                    "sharing_expire":0,
                    "allow_download":false
                }
            ]
        }
    ]
}

目录