You need to enable JavaScript to run this app.
文档中心
视频直播

视频直播

复制全文
下载 pdf
数字人
ListMediaRecordAsyncTasks - 查询数字人口播视频任务列表
复制全文
下载 pdf
ListMediaRecordAsyncTasks - 查询数字人口播视频任务列表

调用 ListMediaRecordAsyncTasks 接口,查看当前账号创建的数字人口播视频生成任务,获取各任务的处理状态以及生成的视频 URL。支持按任务状态筛选,结果按任务创建时间倒序排列。

使用说明

  • 需要批量查看任务时,调用本接口。已知 TaskId 且只需查询单个任务时,调用 QueryMediaRecordAsyncTask 接口。
  • 根据 Status 处理任务:
    • init 或 queued:任务正在初始化或排队,可稍后再次调用本接口查询。
      • running:任务正在处理,可稍后再次调用本接口查询。如果处理时长达到 15 分钟仍未成功,状态将变为 failed。此前 init 和 queued 阶段的耗时不计入处理时长。
      • succeeded:任务处理成功,无需继续查询。通过 VideoUrl 获取生成的视频。每次调用本接口查询都会返回一个指向同一视频的新临时访问链接,链接有效期为 3 天,请及时下载或转存视频。
      • failed 或 timeout:任务处理失败或超时,无需继续查询。通过 ErrorCode 和 ErrorMessage 排查原因。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒。
  • 前提条件:已调用 CreateMediaRecordAsyncTask 接口生成数字人口播视频任务。

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=ListMediaRecordAsyncTasks&Version=2026-04-01

调试

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是ListMediaRecordAsyncTasks接口名称。当前 API 的名称为 ListMediaRecordAsyncTasks。
VersionString是2026-04-01接口版本。当前 API 的版本为 2026-04-01。

Body

参数类型是否必选示例值描述

Status

String

否

succeeded

任务状态。不传则返回所有状态的任务。取值如下:

  • init:初始化中。
  • queued:排队中。
  • running:处理中。
  • succeeded:处理成功。
  • failed:处理失败。
  • timeout:处理超时。
PageNumberInteger否1查询页码。取值大于等于 1,默认值为 1。
PageSizeInteger否20每页最多返回的任务数量。取值范围为 [1, 100]。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数类型示例值描述
TasksArray of Tasks-任务列表,按任务创建时间倒序排列。
TotalInteger37符合筛选条件的任务总数,并非当前页返回的任务数量。
PageNumberInteger1当前页码。
PageSizeInteger20每页任务数量。

Tasks

参数类型示例值描述
TaskIdString8f14e45f-ceea-467a-9c4c-3b4a7d5d6e11任务 ID。

Status

String

succeeded

任务状态。取值如下:

  • init:初始化中。
  • queued:排队中。
  • running:处理中。
  • succeeded:处理成功。
  • failed:处理失败。
  • timeout:处理超时。

VideoUrl

String

https://tos-avatar-upload-bucket-private.tos-cn-beijing.volces.com/2121369266/record/xxx.mp4?X-Tos-Signature=xxx

生成视频的临时访问链接。每次查询都会返回一个指向同一视频的新链接,链接有效期为 3 天。

说明

仅当 Status 为 succeeded 时返回该参数。

ErrorCode

String

MediaRecordFailed

任务处理失败或超时时返回的错误码。

说明

仅当 Status 为 failed 或 timeout 时,该参数有值。

ErrorMessage

String

Detroit media record failed

任务处理失败或超时时返回的错误信息。

说明

仅当 Status 为 failed 或 timeout 时,该参数有值。

请求示例

POST https://live.volcengineapi.com?Action=ListMediaRecordAsyncTasks&Version=2026-04-01
{
    "Status": "succeeded",
    "PageNumber": 1,
    "PageSize": 20
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListMediaRecordAsyncTasks",
        "Version": "2026-04-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "Tasks": [
            {
                "TaskId": "8f14e45f-ceea-467a-9c4c-3b4a7d5d6e11",
                "Status": "succeeded",
                "VideoUrl": "https://tos-avatar-upload-bucket-private.tos-cn-beijing.volces.com/2121369266/record/xxx.mp4?X-Tos-Signature=...",
                "ErrorCode": null,
                "ErrorMessage": null
            }
        ],
        "Total": 37,
        "PageNumber": 1,
        "PageSize": 20
    }
}

错误码

您可访问公共错误码,获取更多错误码信息。

最近更新时间:2026.10.30 14:08:14
这个页面对您有帮助吗?
有用
有用
无用
无用