Query The Status of An AI Agent Instance

Description

This API is used to query the runtime status of an AI agent during voice conversations.

Request prototype

Request method: POST
Request body format: JSON
Request URL: https://aigc-aiagent-api.zegotech.cn?Action=QueryAgentInstanceStatus
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	Unique identifier for the AI agent instance.

Sample Request

Request URL:

Untitled

https://aigc-aiagent-api.zegotech.cn?Action=QueryAgentInstanceStatus
&<Common Request Parameters>

Copied!

Request body:

Untitled

{
    "AgentInstanceId": "1907616178474336256"
}

Copied!

Response Parameters

Parameter	Type	Description
Code	Number	Return code. 0 indicates success, other values indicate failure. For more information on error codes and response handling recommendations, please refer to Return Codes.
Message	String	Explanation of the request result.
RequestId	String	Request ID.
Data	Object	Returned data.
└Status	String	AI agent running status: `IDLE`: Idle `LISTENING`: Listening `THINKING`: Thinking `SPEAKING`: Speaking

Sample Response

Untitled

{
    "Code": 0,
    "Message": "success",
    "RequestId": "1898302332764950528",
    "Data": {
        "Status": "IDLE"
    }
}

Copied!