文档中心

实时音视频

请输入

实时通话字幕和翻译

更新实时字幕 UpdateSubtitle

调用 UpdateSubtitle 接口，更新正在进行的实时字幕任务的配置，如修改用户的源语言、调整翻译的目标语言或指定接收字幕的用户列表。

注意事项

请求频率

单账号下 QPS 不得超过 60。

调用接口

关于调用接口的请求结构、公共参数、签名方法、返回结构，参看调用方法。

请求说明

请求方式：POST

请求地址：https://rtc.volcengineapi.com?Action=UpdateSubtitle&Version=2024-06-01

调试

API Explorer

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

去调试

请求参数

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

Query

Action String 必选示例值：UpdateSubtitle

接口名称。当前 API 的名称为 UpdateSubtitle。

Version String 必选示例值：2024-06-01

接口版本。当前 API 的版本为 2024-06-01。

Body

AppId String 必选示例值：66****3cf

实时音视频应用的 AppId。可在控制台获取。

RoomId String 必选示例值：Room1

需要生成字幕的 RTC 房间 ID。

TaskId String 必选示例值：task1

字幕任务 ID。

VendorConfig Object 必选示例值：-

字幕供应商平台配置。

Type Integer 必选示例值：0

字幕服务供应商。支持取值及含义如下：

0：火山引擎语音技术。

LanguageConfig Object 可选示例值：-

设置用户语音的原始语种；若需翻译字幕，还需设置翻译目标语种。

SourceLanguages Object[] 必选示例值：-

设置用户语音的原始语种。

设置后，系统会根据用户的语音生成对应语言的字幕文本。比如 A 说英文，则 A 的语音对应字幕文本为英文；B 说日语，则 B 的语音对应字幕文本为日语。

注意

如果未为房间内某个用户设置源语种，系统会默认将该用户的语音转录为中文字幕，即使用户实际使用的语言不是中文。这可能导致生成的字幕文本与用户的实际语音不匹配，甚至可能出现无法理解的文本。

房间内所有用户的语音都会转为文字，为了确保字幕的准确性和可读性，建议为房间内的所有用户准确设置源语种。

UserId String 必选示例值：user1

房间内需生成字幕用户对应的 UserId。

LanguageCode String[] 必选示例值：["zh"]

语种代号。前往 RTC 控制台-实时字幕-流式语音识别-语种模型匹配获取或自定义语种代号。

仅支持配置一种语种代号。

RoomTargetLanguages String[] 可选示例值：["en"]

字幕需翻译为的目标语种，请填写语种代号。支持翻译的语种及代号？

注意

仅使用机器翻译服务时，该字段才生效。若使用的是流式语音识别服务，该字段不生效，请置为空。

ReceiverList String[] 可选示例值：["user1","user2"]

字幕返回给客户端时，可指定字幕接收用户。

若指定了接收用户：只有指定的用户可以看到字幕。

若不指定：房间内的所有用户都可以看到字幕。

注意

该参数仅在 DistributionMode 为 1 或 3时生效（即字幕结果接收地包含客户端）。

返回参数

本接口无特有的返回参数。公共返回参数请见返回结构。

其中返回值 Result 仅在请求成功时返回 ok，失败时为空。

请求示例

返回示例

错误码

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

最近更新时间：2026.08.19 18:32:18

这个页面对您有帮助吗？

有用

无用