停止实时字幕 StopSubtitle--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

停止实时字幕 StopSubtitle

最近更新时间：2024.12.27 11:43:02首次发布时间：2024.12.27 11:43:02

在实时音视频通话场景中，若需停止指定字幕任务，你可通过该接口实现。

注意事项

请求频率

单账号下 QPS 不得超过 60。

调用接口

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

请求说明

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

请求参数

Query

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

Body

参数	类型	是否必选	示例值	描述
AppId	String	是	`661e****543cf`	你的音视频应用的唯一标志，参看获取 AppId。
RoomId	String	是	`Room1`	房间的 ID，是房间的唯一标志。赋值规则参看参数赋值规范。
TaskId	String	是	`Task1`	需要终止的任务对应的任务 ID。

返回参数

请求示例

POST https://rtc.volcengineapi.com?Action=StopSubtitle&Version=2024-06-01
{
    "AppId": "661e****543cf",
    "RoomId": "Room1",
    "TaskId": "Task1"
}

返回示例

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