You need to enable JavaScript to run this app.
文档中心
企业直播

企业直播

复制全文
下载 pdf
AI 高光智剪
ListHighlightClipTasks - 查询高光智剪任务列表
复制全文
下载 pdf
ListHighlightClipTasks - 查询高光智剪任务列表

调用 ListHighlightClipTasks 接口,分页查询高光智剪任务列表。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒。
  • 使用子账号调用接口时,仅支持查询该子账号可见的视频所关联的高光智剪任务。
  • 前提条件:确保您拥有火山引擎主账号,或具备媒资库 > 视频管理 > 视频库或直播暂存 > 仅查看或可编辑权限的子账号。有关如何添加子账号,详见权限管理。

请求说明

  • 请求方式:GET
  • 请求地址:https://livesaas.volcengineapi.com/?Action=ListHighlightClipTasks&Version=2023-08-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。

Query

参数类型是否必选示例值描述
ActionString是ListHighlightClipTasks接口名称。当前 API 的名称为 ListHighlightClipTasks。
VersionString是2023-08-01接口版本。当前 API 的版本为 2023-08-01。
SearchNameString是任务名称搜索关键词。支持按高光智剪任务名称或任务 ID 查询。

Status

Integer

是

0

高光智剪任务状态。支持按任务状态查询。取值如下:

  • 0:全部
  • 1:进行中
  • 2:剪辑成功
  • 3:剪辑失败
PageNoLong是1页码,从 1 开始。
PageItemCountLong是10每页返回的任务数量。

返回参数

参数类型示例值描述
HighlightClipJobListArray of HighlightClipJobList-符合查询条件的高光智剪任务列表。
TotalCountInteger10符合查询条件的高光智剪任务总数。

HighlightClipJobList

参数类型示例值描述
VidStringv0c251g7007ada6nr77og65s9o4hv2rg高光智剪任务关联的原视频 Vid。
CoverImageStringhttps://p-boe-sign.bytedance.net/tos-boe-v-c1801c/o0Cqxxx高光智剪任务的封面图片 URL。包含协议头。
CreateTimeInteger1787658478高光智剪任务的创建时间,Unix 时间戳,单位为秒。
IdLong1高光智剪任务 ID。
TitleString剪辑任务名称高光智剪任务的名称。

Status

Integer

1

高光智剪任务状态。取值如下:

  • 1:进行中
  • 2:剪辑成功
  • 3:剪辑失败

请求示例

GET https://livesaas.volcengineapi.com/?Action=ListHighlightClipTasks&Version=2023-08-01&SearchName=任务名称&Status=0&PageNo=1&PageItemCount=10

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListHighlightClipTasks",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1"
    },
    "Result": {
        "HighlightClipJobList": [
            {
                "Vid": "v0c251g7007ada6nr77og65s9o4hv2rg",
                "CoverImage": "https://p-boe-sign.bytedance.net/tos-boe-v-c1801c/o0Cqxxx",
                "CreateTime": 1787658478,
                "Id": 1,
                "Title": "剪辑任务名称",
                "Status": 1
            }
        ],
        "TotalCount": 10
    }
}

错误码

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

最近更新时间:2026.10.10 11:17:09
这个页面对您有帮助吗?
有用
有用
无用
无用