帮你快速理解、总结文档立即下载

更新云端转录任务

最近更新时间:2026-11-10 03:08:57
我的收藏

1. 接口描述

接口请求域名: trtc.tencentcloudapi.com 。

成功开启转录后,可以使用此接口来更新转录任务。仅在转录任务进行时有效,转录退出后更新将会返回错误。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数,本接口取值:ModifyCloudTranscription。
Version 是 String 公共参数,本接口取值:2019-07-22。
Region 是 String 公共参数,详见产品支持的 地域列表,本接口仅支持其中的: ap-beijing, ap-guangzhou, ap-hongkong, ap-shanghai 。
SdkAppId 是 Integer

TRTC的SdkAppId,和转录的房间所对应的SdkAppId相同。


示例值:1400704311
TaskId 是 String

转录任务的唯一Id,在启动转录成功后会返回。


示例值:-nEU7t3BGcLlSMQd6UAdKFhPRNXbS4K-m928oZWQndibHjkrRJJAw****1SjcO6uCAE.
SequenceNumber 是 Integer

客户保证同一个任务,每次更新请求中的SequenceNumber递增,防止请求乱序。


示例值:3
SubscribeUserInfo 否 TranscriptionSubscribeParam

转录订阅用户信息,包括白名单和黑名单。

TranslationParam 否 TranslationParam

转录服务翻译使用的参数。

TTSParam.N 否 Array of TTSParam

转录服务TTS使用的参数。

3. 输出参数

参数名称 类型 描述
TaskId String

转录服务分配的任务 ID。任务 ID 是对一次转录生命周期过程的唯一标识,结束转录时会失去意义。


示例值:-nE5U7t3BGcLlSMQd6UAdKFhPRNXb*S4K-m928oZWQndibHjkrRJJAw****1SjcO6uCAE.
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 更新转录任务

输入示例

POST / HTTP/1.1
Host: trtc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyCloudTranscription
<公共请求参数>

{
    "SdkAppId": 1400704311,
    "TaskId": "-nE****U7t3BGcLlSMQd6UAdKFhPRNXb****S4K-m928oZWQndibHjkrRJJAw****1SjcO6uCAE.",
    "SequenceNumber": 3,
    "SubscribeUserInfo": {
        "SubscribeList": [
            {
                "UserId": "****_test_0"
            }
        ]
    },
    "TranslationParam": {
        "TargetLang": [
            "en"
        ],
        "Terminologies": [
            {
                "TargetLang": "en",
                "Terminology": [
                    {
                        "Source": "腾讯云音视频",
                        "Target": "TRTC"
                    }
                ]
            }
        ]
    },
    "TTSParam": [
        {
            "Model": "flow_02_turbo",
            "Language": "en",
            "TargetUser": {
                "UserId": "****_test_1"
            },
            "TTSRobotUser": {
                "UserId": "tts-robot1"
            },
            "Voice": {
                "VoiceId": "v-female-B7k5WxN4",
                "Speed": 1.99,
                "Volume": 9.99,
                "Pitch": -10
            }
        }
    ]
}

输出示例

{
    "Response": {
        "TaskId": "-nE5***U7t3BGcLlSMQd6UAdKFhPRNXb****S4K-m928oZWQndibHjkrRJJAw****1SjcO6uCAE.",
        "RequestId": "d6ddd3fa-108a-4dd5-b69b-43d93d6ab532"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。

错误码 描述
AuthFailure CAM签名/鉴权错误。
AuthFailure.UnauthorizedOperation CAM鉴权失败。
AuthFailure.UnsupportedOperation 不支持该操作。
FailedOperation 操作失败。
FailedOperation.CTUnsupportMethod 云端转录方法不支持。
InternalError 内部错误。
InternalError.CTInternalError 云端转录内部服务错误。
InvalidParameter 参数错误。
InvalidParameter.OutOfRange 参数超出范围。
InvalidParameter.SdkAppId SdkAppId参数错误。
InvalidParameter.TaskId TaskId 参数错误。
MissingParameter 缺少参数错误。
MissingParameter.Region 缺少Region参数。
MissingParameter.SdkAppId 缺少SdkAppId参数。
MissingParameter.TaskId 缺少TaskId参数。
MissingParameter.UserId 缺少UserId参数。
UnsupportedOperation 操作不支持。