GetAgentInstanceMsgList

POST

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

This interface is used to obtain the message list used as context when interacting with the AI agent instance.

Request

Query Parameters

Action stringrequired

Possible values: [GetAgentInstanceMsgList]

API Prototype Parameter

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

AppId uint32required

💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.

SignatureNonce stringrequired

💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature sample code for how to generate.

Timestamp int64required

💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature sample code for how to generate, with a maximum error of 10 minutes.

Signature stringrequired

💡Public parameter. 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]

Default value: 2.0

💡Public parameter. Signature version number.

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)
Example

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

Total integer

The total number of messages used as context

MessageList object[]

Message list

Array[

Role stringrequired

Possible values: [user, assistant]

The role of the message sender:

user: User
assistant: AI agent

Content stringrequired

Message content

]

{
  "Code": 0,
  "Message": "Success",
  "RequestId": "8825223157230377926",
  "Data": {
    "Total": 10,
    "MessageList": [
      {
        "Role": "user",
        "Content": "Hello, I want to know about the product information"
      }
    ]
  }
}

{
  "Code": 0,
  "Message": "Success",
  "RequestId": "8825223157230377926",
  "Data": {
    "Total": 10,
    "MessageList": [
      {
        "Role": "user",
        "Content": "Hello, I want to know about the product information"
      }
    ]
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "3151527792559699732",
  "Data": {
    "Total": 2,
    "MessageList": [
      {
        "Role": "user",
        "Content": "Hello"
      },
      {
        "Role": "assistant",
        "Content": "Hello! I'm Jacky, a companion assistant created by ZEGOCLOUD. I'm happy to meet you!"
      }
    ]
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "3151527792559699732",
  "Data": {
    "Total": 2,
    "MessageList": [
      {
        "Role": "user",
        "Content": "Hello"
      },
      {
        "Role": "assistant",
        "Content": "Hello! I'm Jacky, a companion assistant created by ZEGOCLOUD. I'm happy to meet you!"
      }
    ]
  }
}