You need to enable JavaScript to run this app.
文档中心
实时音视频

实时音视频

复制全文
下载 pdf
历史版本(建议迁移至新版接口)
结束 AI 对话 StopVoiceChat(建议迁移至新版接口)
复制全文
下载 pdf
结束 AI 对话 StopVoiceChat(建议迁移至新版接口)
主动停止一个正在运行的智能体任务。调用成功后,该任务关联的所有 AI 服务(如 ASR、LLM、TTS)会立即停止工作并停止计费,智能体会退出其所在的 RTC 房间。为避免不必要的资源消耗和费用,建议在对话结束后后及时调用本接口。​
注意​
  • 调用 StopVoiceChat 接口仅会使智能体离开房间,AgentConfig.TargetUserId 用户不会离开房间,仍会产生音视频费用。如需完整结束通话,客户端还需调用 RTC SDK 接口 leaveRoom 使 AgentConfig.TargetUserId 用户离开房间,并调用 destroyRTCEngine销毁引擎实例。​
使用说明​
调用接口​
关于调用接口的请求结构、公共参数、签名方法、返回结构,参看调用方法。​
注意事项​
  • 请求频率: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​
应用的唯一标志。​
需与调用 StartVoiceChat 启动任务时使用的 AppId 保持一致。可在实时音视频_应用管理获取。​
​
RoomId String 必选示例值:Room1​
通话房间 ID。​
需与调用 StartVoiceChat 启动任务时使用的 RoomId 保持一致。​
​
TaskId String 必选示例值:task1​
目标智能体任务的 ID。​
需与调用 StartVoiceChat 启动任务时定义的 TaskId 保持一致。​
​
​
​
返回参数​
本接口无特有的返回参数。公共返回参数请见返回结构。其中返回值 Result 仅在请求成功时返回 ok,失败时为空。​
错误码​
您可访问公共错误码,获取更多错误码信息。​
​

请求示例

POST https://rtc.volcengineapi.com?Action=StopVoiceChat&Version=2024-12-01

{
    "AppId": "661e****543cf",
    "RoomId": "Room1",
    "TaskId": "task1"
}

响应示例

{
   "Result": "ok",     
  "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31", 
       "Action": "StopVoiceChat", 
       "Version": "2024-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    }
}
最近更新时间:2026.09.28 09:46:50
这个页面对您有帮助吗?
有用
有用
无用
无用