UpdateSpeechTask - 更新声影同传任务--视频直播-火山引擎

文档中心

立即注册

导航

视频直播

UpdateSpeechTask - 更新声影同传任务

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

调用 UpdateSpeechTask 接口，更新声影同传任务的功能开启状态。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateSpeechTask`	接口名称。当前 API 的名称为 `UpdateSpeechTask`。
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。
Switch	String	否	`AllDisable`	开关状态。取值如下： `AllDisable`：同时关闭当前模式下的所有功能。 `AllEnable`：同时开启当前模式下的所有功能，但不会开启创建声影同传任务时未开启的功能。

Switch

String

否

AllDisable

开关状态。取值如下：

AllDisable：同时关闭当前模式下的所有功能。
AllEnable：同时开启当前模式下的所有功能，但不会开启创建声影同传任务时未开启的功能。

返回参数

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

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

Data

参数	类型	示例值	描述
OptID	Integer	`2`	任务更新序列号。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestID": "20251117142336C37E6DC6C26C2529018E",
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateSpeechTask",
        "Version": "2023-01-01",
        "Service": "live",
        "Region": "cn-north-1"
    },
    "Result": {
        "Code": 0,
        "Message": "success",
        "Data": {
            "OptID": 2
        }
    }
}

错误码

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