调用 ListActivityMediaAPI 接口，获取媒资库下视频库或直播暂存中视频的信息，包括视频 ID、互动脚本 ID 和视频名称等。
请求频率：单用户请求频率限制为 120 次/分钟。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | ListActivityMediaAPI | 接口名称。当前 API 的名称为 ListActivityMediaAPI。 |
| Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01。 |
| PageNum | Integer | 否 | 1 | 分页查询页码。默认值为 1。取值大于等于 1。 |
| PageSize | Integer | 否 | 10 | 分页查询数量，默认值为 10。 |
SearchType | Integer | 是 |
| 视频的存储位置。取值如下：
|
| Vid | String | 否 | v02a49g10000ck****3c77u8uhf09ebg | 视频 Vid。 |
| Name | String | 否 | A | 视频名称。支持模糊搜索，英文大小写不敏感。例如，当参数值为 A 时，返回视频 A、视频 abc 等名称的视频。 |
SourceType | Integer | 否 |
| 视频的来源。默认返回所有来源的视频。取值如下：
说明 该参数仅在 |
OrderKey | String | 否 |
| 视频排序方式。默认按照视频更新时间降序排列。取值如下：
|
FolderId | Long | 否 |
| 分类 ID。默认值为 说明 该参数仅在 |
IncludeSubFolder | Boolean | 否 |
| 是否包含子分类。默认值为
说明 该参数仅在 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| PageNum | Integer | 1 | 分页查询页数。 |
| PageSize | Integer | 10 | 分页查询数量。 |
| TotalCount | Integer | 1 | 查询结果总数。 |
| Data | Array of Data | - | 视频信息列表。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Id | String | 43**98 | 视频 ID。 |
| MediaName | String | 回放 A | 视频名称。 |
| CoverImage | String | https://www.example.com.image | 视频封面图 URL。默认封面图的 URL 有协议头，通过控制台上传的封面图 URL 没有协议头。 |
| Vid | String | v02a49g10000ck****3c77u8uhf09ebg | 视频 Vid。 |
| MediaVideoDuration | Integer | 191 | 视频时长。单位为秒。 |
MediaLibraryVideoType | Integer |
| 视频的存储位置。取值如下：
|
ReviewStatus | Integer |
| 视频的审核状态。取值如下：
|
| CreateTime | Integer | 1696980251 | 视频的创建时间。Unix 时间戳，单位为秒。若视频是直播暂存转存至视频库，则表示转存至视频库的时间。 |
| UpdateTime | Integer | 1696990559 | 视频的最近更新时间，即最近一次更新视频封面图、名称和互动脚本等的时间。Unix 时间戳，单位为秒。 |
| Creator | String | admin@bytedance.com | 视频的创建者。返回 admin@bytedance.com 表示当前视频由主账号创建。 |
SourceType | Integer |
| 视频的来源。取值如下：
|
| ActivityVideo | Array of ActivityVideo | - | 视频关联的直播间，即正在使用该视频的直播间。 |
| FailureTime | Integer | 1796980251 | 视频的失效时间。取值为 0，表示永久保存，无失效时间。 |
| MediaSize | Integer | 24725029 | 视频的大小。单位为 Byte。 |
| VideoWidth | Long | 1080 | 视频横向像素。VideoWidth 和 VideoHeight 组成了视频的分辨率。 |
| VideoHeight | Long | 1920 | 视频纵向像素。VideoWidth 和 VideoHeight 组成了视频的分辨率。 |
FolderName | String |
| 分类名称。 说明 该参数仅在 |
FolderId | Long |
| 分类 ID。 说明 该参数仅在 |
| InteractionScriptId | Long | 1 | 互动脚本 ID。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Id | Long | 177934****622756 | 直播间 ID。 |
| Name | String | 直播间 A | 直播间名称。 |
GET https://livesaas.volcengineapi.com/?Action=ListActivityMediaAPI&Version=2020-06-01&PageNum=1&PageSize=10&SearchType=2&Vid=v02a49g10000ck****3c77u8uhf09ebg&Name=A&SourceType=2&OrderKey=create_time&FolderId=0&IncludeSubFolder=false
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListActivityMediaAPI", "Version": "2020-06-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "PageNum": 1, "PageSize": 10, "TotalCount": 1, "Data": [ { "Id": "4****8", "MediaName": "回放 A", "CoverImage": "https://www.example.com.image", "Vid": "v02a49g10000ck****3c77u8uhf09ebg", "MediaVideoDuration": 191, "MediaLibraryVideoType": 2, "ReviewStatus": 2, "CreateTime": 1696980251, "UpdateTime": 1696990559, "Creator": "admin@bytedance.com", "SourceType": 2, "ActivityVideo": [ { "Id": 177934****622756, "Name": "直播间 A" } ], "FailureTime": 1796980251, "MediaSize": 24725029, "FolderId": 0, "FolderName": "分类 A", "VideoHeight": 1920, "VideoWidth": 1080, "InteractionScriptId": 1 } ] } }