最近更新时间:2024.01.04 11:49:00
首次发布时间:2022.07.29 10:08:32
获取媒资库下视频库或者直播暂存中视频文件的信息。
请求频率:单用户请求频率限制为 120 次/分钟。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListActivityMediaAPI | 接口名称。当前 API 的名称为 ListActivityMediaAPI 。 |
Version | String | 是 | 2020-06-01 | 接口版本。当前 API 的版本为 2020-06-01 。 |
PageNum | Integer | 否 | 1 | 分页查询页码,默认值为 1 |
PageSize | Integer | 否 | 10 | 分页查询数量,默认值为 10 |
SearchType | Integer | 是 |
| 视频文件的存储位置。
|
Vid | String | 否 | v02a49g10000ckitq63c77u8uhf09ebg | 视频文件的 Vid |
Name | String | 否 | 回放1 | 视频文件的名称 |
SourceType | Integer | 否 |
| 视频文件的来源
|
OrderKey | String | 否 |
| 视频文件排序方式。支持以下两种取值,默认按照视频文件修改时间降序排列。
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageNum | Integer | 1 | 分页查询页数 |
PageSize | Integer | 10 | 分页查询数量 |
TotalCount | Integer | 1 | 获取的视频文件总数 |
Data | Array of Data | - | 获取的视频文件信息 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String | 430998 | 视频记录 ID |
MediaName | String | 回放1 | 视频文件名称 |
CoverImage | String | http://IyBXvr3FqhPAfkSSARz9Q6h4EN0Eu | 视频文件封面图 URL。默认封面图的 URL 有协议头,通过控制台上传的封面图的 URL 没有协议头 |
Vid | String | v02a49g10000ckitq63c77u8uhf09ebg | 视频文件的 Vid |
MediaVideoDuration | Integer | 191 | 视频文件的时长,单位为秒 |
MediaLibraryVideoType | Integer |
| 媒资库视频类型。
|
ReviewStatus | Integer |
| 审核状态
|
CreateTime | Integer | 1696980251 | 视频文件的创建时间 |
UpdateTime | Integer | 1696990559 | 视频文件的更新时间 |
Creator | String | admin@bytedance.com | 视频文件的创建者 |
SourceType | Integer |
| 视频文件的来源。
|
ActivityVideo | Array of ActivityVideo | - | 视频文件关联的直播间 |
FailureTime | Integer | 0 | 视频文件的失效时间。取值为 0 ,表示无失效时间 |
MediaSize | Integer | 24725029 | 视频文件的大小,单位为Byte |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | Long | 1779348423622756 | 直播间 ID |
Name | String | 回放 | 直播间名称 |
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 } ] } }
访问公共错误码获取详细信息。