接口描述
描述:
调用本接口可以用来实现查询会议录制列表功能。该功能仅支持用户为创建者时才能获取录制文件列表。
当您想实时监测会议录制相关状况时,您可以通过订阅 录制管理 中的相关事件,接收事件通知。
请求方法:GET
鉴权方式:AK/SK 鉴权 、OAuth 2.0鉴权。
依赖权限点:
自建应用:具备管理企业录制和查看企业录制权限。
三方应用:具备查看您的录制、查看和管理您的录制权限。
Operator 用户角色:勾选账户管理 > 录制管理 > 查看权限。可前往用户管理 > 角色管理页面设置。
接口请求域名:
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}
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
operator_id | 是 | String | 操作者 ID。operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。 说明: 仅会议创建者、企业超级管理员或有企业录制管理权限的用户可调用。当会议 ID 和会议 code 均为空时,表示查询用户所有会议的录制列表(企业内部请使用企业唯一用户标识;OAuth 2.0鉴权用户请使用 openId)。 企业唯一用户标识说明: 1:企业对接 SSO 时使用的员工唯一标识 ID。 2:企业调用创建用户接口时传递的 userid 参数。 |
operator_id_type | 是 | Integer | 操作者 ID 的类型: 1:userid 2:openid 3:rooms_id |
meeting_id | 否 | String | 会议 ID,作为某场会议的唯一标识,建议优先根据会议 ID 查询。 |
meeting_code | 否 | String | 会议 code,会议 App 的呼入号码,用于某场会议的补充查询条件(非唯一标识)。 |
start_time | 是 | Integer | 查询起始时间戳,UNIX 时间戳(单位秒)。 说明:时间区间不允许超过31天。 |
end_time | 是 | Integer | 查询结束时间戳,UNIX 时间戳(单位秒)。 说明:时间区间不允许超过31天。 |
page_size | 否 | Integer | 分页大小,默认值为10,最大为20。 |
page | 否 | Integer | 页码,从1开始,默认值为1。 |
media_set_type | 否 | Number | 会议类型: 0:全部 1:公网会议 2:专网会议 |
query_record_type | 否 | Integer | 录制文件类型,默认为 1: 0:全部 1:云录制 2:上传录制 3:文字转写 |
输出参数
参数名称 | 参数类型 | 参数描述 |
total_count | Integer | 分页查询返回数据总数。 |
current_size | Integer | 分页查询返回单页数据条数。 |
current_page | Integer | 分页查询返回当前页码。 |
total_page | Integer | 分页查询返回分页总数。 |
record_meetings | 会议录制列表。 |
RecordMeeting 对象
参数名称 | 参数类型 | 参数描述 |
meeting_record_id | String | 会议录制 ID。 |
meeting_id | String | 会议 ID。 |
meeting_code | String | 会议 code。 |
media_set_type | Number | 会议类型: 1:公网会议 2:专网会议 |
host_user_id | String | 会议创建者 ID。 |
media_start_time | Integer | 会议开始时间,UNIX 时间戳(单位毫秒)。 |
subject | String | 会议主题。 |
state | Integer | 录制状态: 1:录制中 2:转码中 3:转码完成 当状态为转码完成才会返回录制文件列表。 |
record_type | Integer | 返回的录制文件类型。 0:云录制文件 2:上传录制文件 |
record_files | 录制文件列表。 |
RecordFile 对象
参数名称 | 参数类型 | 参数描述 |
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 | 是否允许下载,开启共享时返回。 |
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 9042 | 无权限进行该操作,建议检查操作者身份或资源归属。 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
400 | 500014 | 账号无权限。 |
400 | 200001 | API 请求头缺失必填字段。 |
400 | 190301 | 请求重放错误,请求头里的 X-TC-Timestamp 和 X-TC-Nonce 每次请求时需重新生成,不能使用和过去五分钟内相同的 timestamp 和 nonce。 |
500 | 202004 | OAuth 鉴权时查询 secret 信息失败。 |
500 | 190310 | 每分钟总接口调用次数超过限制。 |
500 | 960000 | 网络错误,请稍后重试。 |
500 | 50055 | 查询会议异常。 |
500 | 28 | 服务错误,请稍后重试。 |
500 | 41 | 网络超时。 |
500 | 190001 | 存在未注册的用户。 |
示例
输入示例
GET https://api.meeting.qq.com/v1/records?meeting_code=423111111&start_time=1602950400&end_time=1603123200&operator_id=KM4Ss4Th09ogUw1JiK&operator_id_type=1
输出示例
{"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_type":0,"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}]}]}