关闭智能体 StopVoiceChat--实时音视频-火山引擎

文档中心

立即注册

导航

实时音视频

关闭智能体 StopVoiceChat

最近更新时间：2024.12.31 17:06:30首次发布时间：2024.12.31 16:11:14

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

在实时音视频通话场景中，若你需要结束智能体的语音聊天服务，可以通过调用此接口实现。

使用说明

调用接口

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

注意事项

请求频率：QPS 不得超过 60。
该接口请求接入地址仅支持 rtc.volcengineapi.com。

请求说明

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

调试

API Explorer

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

去调试

请求参数

Query

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

Body

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

返回参数

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

请求示例

POST https://rtc.volcengineapi.com?Action=StopVoiceChat&Version=2024-12-01
{
    "AppId": "661e****543cf",
    "RoomId": "Room1",
    "UserId": "user1"
}

返回示例

{
    "Result": "ok",
    "ResponseMetadata": {
        "RequestId": "Your_Re20230****10420questId",
        "Action": "StopVoiceChat",
        "Version": "2024-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
        }
}