StopListening

2026-08-25

POST

https://aigc-aiagent-api.zegotech.cn/

对讲机模式下，智能体结束聆听。对讲机模式开启请参考创建智能体实例的 AdvancedConfig.CommunicationMode 参数说明。

该能力也可以通过客户端 ZEGO Express SDK 发送房间信令实现相同效果，无需服务端接口调用。详情请查看客户端文档智能体自定义控制。

Request

Query Parameters

Action string必填

可选值: [StopListening]

接口原型参数

https://aigc-aiagent-api.zegotech.cn?Action=StopListening

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

application/json

Body

required

AgentInstanceId string必填

Agent 实例的唯一标识，全局唯一。

UserId string

结束聆听模式的用户。默认使用创建的时候绑定的UserId。

Sequence int64

客户端自己定义的跟随请求有序增加的序列号。每个用户/设备独立递增。AI Agent 后台只处理 Sequence 最新的请求。如果不传，则按 AI Agent 后台接收顺序处理，由于网络问题可能会导致用户说话的顺序和后台接收的顺序不一致。

📌 重要说明

StartListening 和 StopListening 接口的 Sequence 必须有序。比如：

StartListening(Sequence:1)

StopListening(Sequence:2)

StartListening(Sequence:3)

StopListening(Sequence:4)

...

CancelFlag boolean

默认值: false

是否取消本轮聆听。默认 false。

false（默认）：正常结束聆听，进入 ASR/LLM 流程，AI 将根据用户说话内容进行回复。
true：取消本轮聆听。停止 ASR，丢弃本轮缓存的音频和已识别结果，不外抛 ASR 终态回调、不请求 LLM/TTS、不写入历史。Agent 实例状态将从 listening 变为 idle。

Responses

结束聆听成功

application/json

数据结构
按数据结构生成的示例

Schema

Code integer

返回码，0 表示成功，其他值表示失败。详情请参考返回码说明。

Message string

请求结果说明

RequestId string

请求 ID

Data object

响应数据

Round int64

本轮的 Round（轮次）

{
  "Code": 0,
  "Message": "success",
  "RequestId": "8916619579948490296",
  "Data": {
    "Round": 158422001
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "8916619579948490296",
  "Data": {
    "Round": 158422001
  }
}