QueryAgentInstanceStatus

POST

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

This interface is used to query the running status information of the AI agent instance in a voice conversation.

Request

Query Parameters

Action stringrequired

Possible values: [QueryAgentInstanceStatus]

API Prototype Parameter

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

AppId uint32required

The unique Application ID assigned to your project by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.

SignatureNonce stringrequired

Random string.

Timestamp int64required

Unix timestamp, in seconds. The maximum allowed error is 10 minutes.

Signature stringrequired

Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.

SignatureVersion stringrequired

Possible values: [2.0]

Signature version number, default value is 2.0.

application/json

Body

required

AgentInstanceId stringrequired

The unique identifier of the AI agent instance, obtained through the response parameters of the Create AI Agent Instance interface.

Responses

Success

application/json

Schema
Example (from schema)

Schema

Code integer

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

Status string

Possible values: [IDLE, LISTENING, THINKING, SPEAKING]

AI Agent running status

{
  "Code": 0,
  "Message": "Success",
  "RequestId": "8825223157230377926",
  "Data": {
    "Status": "IDLE"
  }
}

{
  "Code": 0,
  "Message": "Success",
  "RequestId": "8825223157230377926",
  "Data": {
    "Status": "IDLE"
  }
}

CURL

RESPONSEClear

Click the "Send" button above and see the response here!