GetAgentInstanceMsgList

POST

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

本接口用于在与智能体实例进行语音对话时，获取被用作上下文的消息列表。

Request

Query Parameters

Action string必填

可选值: [GetAgentInstanceMsgList]

接口原型参数

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

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必填

智能体实例的唯一标识，通过创建智能体实例接口的响应参数获取。

Responses

获取成功

application/json

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

Schema

Code integer

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

Message string

请求结果说明

RequestId string

请求 ID

Data object

Total integer

被用作上下文的消息总数

MessageList object[]

消息列表

Array[

Role string必填

可选值: [user, assistant]

消息发送者的角色

user: 用户
assistant: 智能体

Content string必填

消息内容

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "3151527792559699732",
  "Data": {
    "Total": 10,
    "MessageList": [
      {
        "Role": "user",
        "Content": "你好，我想了解一下产品信息"
      }
    ]
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "3151527792559699732",
  "Data": {
    "Total": 10,
    "MessageList": [
      {
        "Role": "user",
        "Content": "你好，我想了解一下产品信息"
      }
    ]
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "3151527792559699732",
  "Data": {
    "Total": 2,
    "MessageList": [
      {
        "Role": "user",
        "Content": "你好"
      },
      {
        "Role": "assistant",
        "Content": "你好！我是小智，很高兴认识你！"
      }
    ]
  }
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "3151527792559699732",
  "Data": {
    "Total": 2,
    "MessageList": [
      {
        "Role": "user",
        "Content": "你好"
      },
      {
        "Role": "assistant",
        "Content": "你好！我是小智，很高兴认识你！"
      }
    ]
  }
}