DeleteSpeechTask - 删除声影同传任务--视频直播-火山引擎

文档中心

立即注册

导航

视频直播

DeleteSpeechTask - 删除声影同传任务

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

调用 DeleteSpeechTask 接口，删除不再需要的声影同传任务。如果任务在运行中，会先停止任务再删除任务。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

Body

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

TaskID String 是 497430****75c378 任务 ID。可通过调用 CreateSpeechTask 或 SearchSpeechTask 获取 ID。

参数	类型	是否必选	示例值	描述
TaskID	String	是	`497430****75c378`	任务 ID。可通过调用 CreateSpeechTask 或 SearchSpeechTask 获取 ID。
WithRecord	Boolean	否	`true`	是否同步删除记录。默认值为 `false`。取值如下： `true`：删除记录，之后无法通过 SearchSpeechTask 接口搜索到该任务。 `false`：保留记录。

WithRecord

Boolean

否

true

是否同步删除记录。默认值为 false。取值如下：

true：删除记录，之后无法通过 SearchSpeechTask 接口搜索到该任务。
false：保留记录。

返回参数

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

参数	类型	示例值	描述
Code	Integer	`0`	状态码。
Message	String	`success`	状态信息。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestID": "2025111417343916C47E772ECEBC0183DC",
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DeleteSpeechTask",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "Code": 0,
        "Message": "success"
    }
}

错误码

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