GetSpeechTask - 查询声影同传任务--视频直播-火山引擎

文档中心

立即注册

导航

视频直播

GetSpeechTask - 查询声影同传任务

最近更新时间：2025.12.09 16:52:33首次发布时间：2025.12.09 16:52:33

调用 GetSpeechTask 接口，查询指定声影同传任务的信息。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

请求方式：POST
请求地址：https://live.volcengineapi.com?Action=GetSpeechTask&Version=2023-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetSpeechTask`	接口名称。当前 API 的名称为 `GetSpeechTask`。
Version	String	是	`2023-01-01`	接口版本。当前 API 的版本为 `2023-01-01`。

Body

参数	类型	是否必选	示例值	描述
TaskID	String	是	`497430****75c378`	任务 ID。可通过调用 CreateSpeechTask 或 SearchSpeechTask 获取 ID。

返回参数

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

参数	类型	示例值	描述
Code	Integer	`0`	状态码。
Message	String	`success`	状态信息。
Data	Object of Data	`-`	任务信息。

Data

参数	类型	示例值	描述
Name	String	`TaskA`	任务名称。
Status	String	`done`	任务状态。取值如下： `running`：运行中。 `done`：已结束。 `prestop`：关闭中。 `init`：准备中。 `prepare`：启动中。
TaskID	String	`497430****75c378`	任务 ID。
CreatedAt	String	`2025-11-14T15:34:43+08:00`	任务创建时间。遵循 RFC3339 格式的东八区（UTC+8）时间，精度为秒。
UpdatedAt	String	`2025-11-14T16:50:53+08:00`	任务更新时间。遵循 RFC3339 格式的东八区（UTC+8）时间，精度为秒。
StoppedAt	String	`2025-11-14T16:50:49+08:00`	任务结束时间。遵循 RFC3339 格式的东八区（UTC+8）时间，精度为秒。
Rule	String	`{"Pipe":"mix","Delay":15,"Source":{"Url":"https://pull-demo.volcfcdnrd.com/live/cloud.flv"},"Output":{"Url":["rtmp://push-demo.volcfcdnrd.com/live/cloud_x?volcTime=1782811835&volcSecret=eecf2a8e2c00b40b4b77390f2305fa7f"]},"Subtitle":{"Original":{"Border":{"W":1,"Color":"black@0.5"},"Font":"arial","FontColor":"white","Language":"zh"},"Translation":[{"Border":{"W":1,"Color":"black@0.5"},"Font":"arial","FontColor":"white","Language":"en"}]}}`	任务的规则配置，为 JSON 格式的字符串，包含任务类型、源流地址、转推地址、字幕配置等信息。具体字段说明可参考 CreateSpeechTask 文档。

请求示例

POST https://live.volcengineapi.com?Action=GetSpeechTask&Version=2023-01-01
{
    "TaskID": "497430****75c378"
}

返回示例

{
    "ResponseMetadata": {
        "RequestID": "20251114171722145C604658CB14014261",
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetSpeechTask",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "Code": 0,
        "Message": "success",
        "Data": {
            "Name": "TaskA",
            "Status": "done",
            "TaskID": "497430****75c378",
            "CreatedAt": "2025-11-14T15:34:43+08:00",
            "UpdatedAt": "2025-11-14T16:50:53+08:00",
            "StoppedAt": "2025-11-14T16:50:49+08:00",
            "Rule": "{\"Pipe\":\"mix\",\"Delay\":15,\"Source\":{\"Url\":\"https://pull-demo.volcfcdnrd.com/live/cloud.flv\"},\"Output\":{\"Url\":[\"rtmp://push-demo.volcfcdnrd.com/live/cloud_x?volcTime=1782811835&volcSecret=eecf2a8e2c00b40b4b77390f2305fa7f\"]},\"Subtitle\":{\"Original\":{\"Border\":{\"W\":1,\"Color\":\"black@0.5\"},\"Font\":\"arial\",\"FontColor\":\"white\",\"Language\":\"zh\"},\"Translation\":[{\"Border\":{\"W\":1,\"Color\":\"black@0.5\"},\"Font\":\"arial\",\"FontColor\":\"white\",\"Language\":\"en\"}]}}"
        }
    }
}

错误码

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