Skip to content

Record History API

录制历史相关接口文档。

查询直播记录

查询指定房间的直播记录列表,支持分页和时间范围筛选。

接口地址: GET /record-history/list

请求参数:

参数名类型必填说明
room_idstring房间号
platformstring平台名称
pagenumber页码,默认为 1
pageSizenumber每页条数,默认为 100
startTimenumber开始时间(时间戳,单位:秒)
endTimenumber结束时间(时间戳,单位:秒)

返回数据:

json
{
  "code": 200,
  "data": [
    {
      "id": 1,
      "created_at": 1730275200,
      "streamer_id": 1,
      "live_id": "live_123456",
      "live_start_time": 1730275200,
      "record_start_time": 1730275210,
      "record_end_time": 1730280000,
      "title": "直播标题",
      "video_file": "/path/to/video.flv",
      "video_duration": 4790.5,
      "danma_num": 1250,
      "interact_num": 320,
      "danma_density": 0.26
    }
  ],
  "pagination": {
    "total": 100,
    "page": 1,
    "pageSize": 100
  }
}

返回参数说明:

参数名类型说明
codenumber状态码,200表示成功
dataarray记录列表
data[].idnumber记录ID
data[].streamer_idnumber主播ID
data[].live_idstring直播ID
data[].live_start_timenumber直播开始时间(时间戳,单位:秒)
data[].record_start_timenumber视频录制开始时间(时间戳,单位:秒)
data[].record_end_timenumber视频录制结束时间(时间戳,单位:秒)
data[].titlestring直播标题
data[].video_filestring视频文件路径
data[].video_durationnumber视频持续时长(单位:秒,浮点数)
data[].danma_numnumber弹幕数量
data[].interact_numnumber互动人数
data[].danma_densitynumber弹幕密度(弹幕数/视频时长,保留两位小数)
data[].created_atnumber创建时间(时间戳,单位:秒)
paginationobject分页信息
pagination.totalnumber总记录数
pagination.pagenumber当前页码
pagination.pageSizenumber每页条数

删除直播记录

删除指定的直播记录。

接口地址: DELETE /record-history/:id

路径参数:

参数名类型必填说明
idnumber记录ID

返回数据:

json
{
  "code": 200,
  "message": "删除成功"
}

返回参数说明:

参数名类型说明
codenumber状态码,200表示成功
messagestring操作结果信息

WARNING

该操作仅删除数据库记录,不会删除实际的视频文件。

获取文件信息

获取相关的文件信息

接口地址: GET /record-history/file/:id

路径参数:

参数名类型必填说明
idnumber记录ID

返回数据:

json
{
  "videoFileId": "abc123def456",
  "videoFileExt": "flv",
  "videoFilePath": "/video.mp4",
  "danmaFilePath": "/video.xml",
  "danmaFileId": "waa",
  "danmaFileExt": "xml"
}

返回参数说明:

参数名类型说明
videoFilePathstring视频文件实际路径,优先查找记录的文件,其次查找 mp4 文件
videoFileIdstring文件ID,用于后续的文件下载操作
videoFileExtstring视频文件类型,可能的值: flv(FLV格式)、ts(TS格式)或空字符串
danmaFilePathstring | null弹幕文件实际路径,优先查找记录的文件,其次查找 ass 文件
danmaFileIdstring | null弹幕ID
danmaFileExtstring | null弹幕类型,xmlass

Released under the GPLv3 License.