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

开启音频切片后,你可以使用 StopSegment 关闭音频切片。

接口行为

你可以调用 StopSegment 接口,关闭已启动的音频切片任务。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI。

接口限制

QPS 不得超过 150。

请求方式

Post

请求参数
Query
参数名类型必填示例值描述
ActionString是StopSegment接口名称,本接口取值:StopSegment
VersionString是2022-06-01接口版本,本接口取值:2022-06-01
Body
参数名类型必填示例值描述
AppIdString是Your_AppId应用的唯一标志
BusinessIdString否Your_BusinessId业务标识
RoomIdString是Your_RoomId房间 ID,是房间的唯一标志
TaskIdString是Your_TaskId你需要关闭的音频切片任务的 ID。
请求示例代码
Query
https://rtc.volcengineapi.com?Action=StopSegment&Version=2022-06-01
postscript
Body
{
    "AppId": "Your_AppId",
    "BusinessId": "Your_BusinessId",
    "RoomId": "Your_RoomId",
    "TaskId": "Your_TaskId"
}
json
返回调用结果

返回值 Result 仅在请求成功时返回"ok",失败时为空。

正常返回示例
{
    "Result": "ok",
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "StopSegment",
        "Version": "2022-06-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}
json