获取智能体实例上下文列表

描述

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

接口原型

请求方法：POST
请求体格式：JSON
请求地址：https://aigc-aiagent-api.zegotech.cn?Action=GetAgentInstanceMsgList
传输协议：HTTPS
调用频率限制：10 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
AgentInstanceId	String	是	智能体实例的唯一标识。

请求示例

请求地址 URL：

Untitled

https://aigc-aiagent-api.zegotech.cn?Action=GetAgentInstanceMsgList
&<公共请求参数>

Copied!

请求消息体：

Untitled

{
    "AgentInstanceId": "1907616178474336256"
}

Copied!

响应参数

参数	类型	描述
Code	Number	返回码。0 表示成功，其他值表示失败。如需了解错误码及响应处理建议，请参考返回码。
Message	String	请求结果的说明信息。
RequestId	String	请求 ID。
Data	Object	返回数据。
└Total	Number	作为上下文的消息总数。
└MessageList	Array of Object	作为上下文的消息列表。本参数结构，请参考 MessageList。目前最多支持返回 100 条上下文消息，消息排序按照时间升序。

MessageList

参数	类型	是否必选	描述
Role	String	是	消息发送者角色。取值如下： `user`：用户。 `assistant`：智能体
Content	String	是	发送的内容。

响应示例

Untitled

{
    "Code": 0,
    "Message": "success",
    "RequestId": "2537521374375652066",
    "Data": {
        "Total": 4,
        "MessageList": [
            {
                "Role": "user",
                "Content": "你叫什么名字？"
            },
            {
                "Role": "assistant",
                "Content": "我叫豆包呀。"
            },
            {
                "Role": "user",
                "Content": "给我讲故事。"
            },
            {
                "Role": "assistant",
                "Content": "好呀，我给你讲一个《三只小猪》的故事吧。"
            }
        ]
    }
}

Copied!