You need to enable JavaScript to run this app.
导航
更新实时字幕 UpdateSubtitle
最近更新时间:2024.12.27 11:43:02首次发布时间:2024.12.27 11:43:02

在实时音视频通话场景中,若你需要对开启的字幕任务进行更新,如更新生成字幕目标用户,生成字幕语言,你可以使用该接口实现。

注意事项

请求频率

单账号下 QPS 不得超过 60。

调用接口

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

请求说明

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

请求参数

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

Query

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

Body

参数
类型
是否必选
示例值
描述
AppId
String
661e****543cf
你的音视频应用的唯一标志,参看获取 AppId
RoomId
String
Room1
房间的 ID,是房间的唯一标志。赋值规则参看参数赋值规范
TaskId
String
task1
字幕任务 ID。
VendorConfig
Object
-
字幕供应商平台配置。
Type
Integer
0
字幕服务供应商。支持取值及含义如下:
0:火山引擎语音技术。
LanguageConfig
Object
-
字幕源语种和目标语种配置
SourceLanguages
Object[]
-
字幕源语种配置。
UserId
String
user1
房间内需生成字幕用户对应的 UserId
LanguageCode
String[]
["zh"]
语种代号。 前往 RTC 控制台-实时字幕-流式语音识别-语种模型匹配获取或自定义语种代号。
仅支持配置一种语种代号。
RoomTargetLanguages
String[]
["zh"]
字幕目标语种代号,默认源语种相同。
ReceiverList
String[]
["user1","user2"]
字幕结果回调给客户端时,接收用户列表。

返回参数

本接口无特有的返回参数。公共返回参数请见返回结构
其中返回值 Result 仅在请求成功时返回 ok,失败时为空。

请求示例

POST https://rtc.volcengineapi.com?Action=UpdateSubtitle&Version=2024-06-01
{
    "AppId": "661e****543cf",
    "RoomId": "Room1",
    "TaskId": "task1",
    "VendorConfig": {
        "Type": 0
    },
    "LanguageConfig": {
        "SourceLanguages": [
            {
                "UserId": "user1",
                "LanguageCode": [
                    "zh"
                ]
            }
        ],
        "RoomTargetLanguages": [
            "zh"
        ]
    },
    "ReceiverList": [
        "user1",
        "user2"
    ]
}

返回示例

{
    "Result": "ok",
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateSubtitle",
        "Version": "2024-06-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}