Interrupt Agent Instance

Description

This API is used to interrupt the agent instance in a voice conversation.

Request prototype

Request method: POST
Request body format: JSON
Request URL: https://aigc-aiagent-api.zegotech.cn?Action=InterruptAgentInstance
Transmission protocol: HTTPS
QPS limit: 10 times/second

Request parameters

Listed below are the parameters specific to this request and part of the common request parameters. For the complete list of common request parameters, see Accessing Server APIs - Common request parameters.

Parameter	Type	Required	Description
AgentInstanceId	String	Yes	The unique identifier of the agent instance.

Request example

Request URL:

Untitled

https://aigc-aiagent-api.zegotech.cn?Action=InterruptAgentInstance
&<Common request parameters>

Copied!

Request body:

Untitled

{
    "AgentInstanceId": "1907616178474336256"
}

Copied!

Response parameters

Parameter	Type	Description
Code	Number	The return code. 0 indicates success, and other values indicate failure. For error codes and response processing suggestions, see Return codes.
Message	String	The description of the request result.
RequestId	String	The request ID.

Response example

Untitled

{
    "Code": 0,
    "Message": "success",
    "RequestId": "6952809118452315328"
}

Copied!