You need to enable JavaScript to run this app.
导航
结束音频切片 StopSegment
最近更新时间:2024.06.20 15:25:19首次发布时间:2024.01.03 20:25:18

本文档 API 接口为最新版本接口,后续相关功能的新增都会在此更新,推荐使用最新版本接口。旧版接口文档请参考历史版本

在实时音视频通话场景中,若需终止正在进行的音频切片任务,你可通过调用此接口实现。

通过指定应用标志、业务标识、房间 ID以及任务 ID,你可以结束特定的音频切片任务。请求成功后,接口将返回操作结果,确认任务是否成功关闭。

注意事项

请求频率:QPS 不得超过 150。

请求说明

  • 请求方式:POST
  • 请求地址:https://rtc.volcengineapi.com?Action=StopSegment&Version=2023-11-01

调试

请求参数

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

Query

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

Body

参数
类型
是否必选
示例值
描述
AppId
String
661e****543cf
你的音视频应用的唯一标志,参看获取 AppId
BusinessId
String
BD**423
业务标识
RoomId
String
Room1
房间 ID,是房间的唯一标志
TaskId
String
Task1

你需要关闭的音频切片任务的 ID。

TaskId 是任务的标识,在一个 AppIdRoomIdtaskId 是唯一的,不同 AppId 或者不同 RoomIdTaskId 可以重复,因此 AppId + RoomId + TaskId 是任务的唯一标识,可以用来标识指定 AppId 下某个房间内正在运行的任务,从而能在此任务运行中进行更新或者停止此任务。

关于 TaskId 及以上 Id 字段的命名规则符合正则表达式:[a-zA-Z0-9_@\-\.]{1,128}

返回参数

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

请求示例

POST https://rtc.volcengineapi.com?Action=StopSegment&Version=2023-11-01
{
    "AppId": "661e****543cf",
    "BusinessId": "BD**423",
    "RoomId": "Room1",
    "TaskId": "Task1"
}

返回示例

{
    "Result": "ok",
    "ResponseMetadata": {
        "RequestId": "20230****10420",
        "Action": "StopSegment",
        "Version": "2023-11-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}

错误码

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