You need to enable JavaScript to run this app.
导航

获取媒资库视频文件信息列表

最近更新时间2024.01.04 11:49:00

首次发布时间2022.07.29 10:08:32

获取媒资库下视频库或者直播暂存中视频文件的信息。

注意事项

请求频率:单用户请求频率限制为 120 次/分钟

请求说明

  • 请求方式:GET
  • 请求地址:https://livesaas.volcengineapi.com/?Action=ListActivityMediaAPI&Version=2020-06-01

请求参数

以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数

Query

参数类型是否必选示例值描述
ActionStringListActivityMediaAPI接口名称。当前 API 的名称为 ListActivityMediaAPI
VersionString2020-06-01接口版本。当前 API 的版本为 2020-06-01
PageNumInteger1分页查询页码,默认值为 1
PageSizeInteger10分页查询数量,默认值为 10

SearchType

Integer

2

视频文件的存储位置。

  • 1:视频库;
  • 2:直播暂存。
VidStringv02a49g10000ckitq63c77u8uhf09ebg视频文件的 Vid
NameString回放1视频文件的名称

SourceType

Integer

2

视频文件的来源

  • 1:上传;
  • 2:直播录制;
  • 3:云剪辑。

OrderKey

String

create_time

视频文件排序方式。支持以下两种取值,默认按照视频文件修改时间降序排列。

  • create_time:按照视频文件创建时间降序排列;
  • 其他:按照视频文件修改时间降序排列。

返回参数

参数类型示例值描述
PageNumInteger1分页查询页数
PageSizeInteger10分页查询数量
TotalCountInteger1获取的视频文件总数
DataArray of Data-获取的视频文件信息

Data

参数类型示例值描述
IdString430998视频记录 ID
MediaNameString回放1视频文件名称
CoverImageStringhttp://IyBXvr3FqhPAfkSSARz9Q6h4EN0Eu视频文件封面图 URL。默认封面图的 URL 有协议头,通过控制台上传的封面图的 URL 没有协议头
VidStringv02a49g10000ckitq63c77u8uhf09ebg视频文件的 Vid
MediaVideoDurationInteger191视频文件的时长,单位为秒

MediaLibraryVideoType

Integer

1

媒资库视频类型。

  • 1:视频库;
  • 2:直播暂存。

ReviewStatus

Integer

2

审核状态

  • 1:未审核;
  • 2:已审核。
CreateTimeInteger1696980251视频文件的创建时间
UpdateTimeInteger1696990559视频文件的更新时间
CreatorStringadmin@bytedance.com视频文件的创建者

SourceType

Integer

2

视频文件的来源。

  • 1:上传;
  • 2:直播录制;
  • 3:云剪辑。
ActivityVideoArray of ActivityVideo-视频文件关联的直播间
FailureTimeInteger0视频文件的失效时间。取值为 0,表示无失效时间
MediaSizeInteger24725029视频文件的大小,单位为Byte

ActivityVideo

参数类型示例值描述
IdLong1779348423622756直播间 ID
NameString回放直播间名称

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListActivityMediaAPI&Version=2020-06-01&PageNum=1&PageSize=10&SearchType=2&Vid=v02a49g10000ckitq63c77u8uhf09ebg&Name=回放1&SourceType=2&OrderKey=create_time

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202310111626371401194CBBE248929D32",
    "Action": "ListActivityMediaAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1697012797
  },
  "Result": {
      "PageNum": 1,
      "PageSize": 10,
      "TotalCount": 1,
      "Data": [
      {
        "Id": "430998",
        "MediaName": "回放1",
        "CoverImage": "http://IyBXvr3FqhPAfkSSARz9Q6h4EN0Eu",
        "Vid": "v02a49g10000ckitq63c77u8uhf09ebg",
        "MediaVideoDuration": 191,
        "MediaLibraryVideoType": 1,
        "ReviewStatus": 2,
        "CreateTime": "1696980251",
        "UpdateTime": "1696990559",
        "Creator": "admin@bytedance.com",
        "SourceType": 2,
        "ActivityVideo": [
          {
            "Id": 1779338178912263,
            "Name": "ppt111"
          },
          {
            "Id": 1779348423622756,
            "Name": "回放"
          }
        ],
        "FailureTime": "0",
        "MediaSize": 24725029
      }
    ]
  }
}

错误码

访问公共错误码获取详细信息。