输入关键词搜索

查询历史对话

更新时间: 2025/09/04 11:01:41

查询历史对话消息接口,支持按时间范围和分页方式获取智能体中的消息记录。

请求信息

请求 URI

GET https://rtc-agent.yunxinapi.com/v1/messages

请求头参数

请求 Header 的参数说明请参考 请求结构

请求查询参数

参数名称 类型 是否必选 示例 说明
agentId String 3cb16a1a0f774b299eaa921007064891 Agent ID,用于标识特定的服务实例
uid String user1 用户 ID,查询该用户的消息历史
beginTimeMs Long 1746531559000 查询开始时间戳(毫秒)
endTimeMs Long 1746533157000 查询截止时间戳(毫秒),必须大于 beginTimeMs
limit Integer 100 每页返回的消息条数上限,取值范围为 1-100
pageToken String cvxsaxccd 分页标识符。如果为空,则从第一页开始查询。如果响应中包含 nextToken,则可以使用该值获取下一页数据
order String asc 排序方式。
  • desc:按时间戳从大到小排序(默认值)
  • asc:按时间戳从小到大排序

请求示例

curl https://rtc-agent.yunxinapi.com/v1/messages?agentId=3cb16a1a0f774b299eaa921007064891&uid=user1&beginTimeMs=1746531559000&endTimeMs=1746533157000&limit=100&order=asc

响应信息

响应参数

参数名称 类型 说明 是否必返回
code Integer 状态码,200 表示请求成功
message String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"
- data Object 返回的数据对象,请求失败则返回空对象
hasMore Boolean 是否还有更多数据
nextToken String 分页标识符,用于请求下一页数据。当 hasMoretrue 时返回
- items Array 返回的历史消息列表
messageServerId Long 服务端消息 ID,全局唯一
role String 消息发送者角色。
  • user:用户
  • assistant:助手
type String 消息类型。
  • text:文本消息
  • image_url:图片 URL 消息
createTime Long 消息发送时间戳,单位毫秒
text String 消息内容。文本消息为具体内容,多媒体消息为描述文本
imported Boolean 是否为导入的消息。
attachment Object 多媒体消息的属性或自定义消息内容

响应体示例

JSON{
  "code": 200,
  "message": "success",
  "data": {
    "hasMore": true,
    "nextToken": "cvxsaxccd",
    "items": [
      {
        "messageServerId": 365695800,
        "role": "user",
        "type": "text",
        "createTime": 1745915669062,
        "text": "你好,你是谁啊",
        "imported": false
      },
      {
        "messageServerId": 365695801,
        "role": "assistant",
        "type": "text",
        "createTime": 1745915670062,
        "text": "我是网易小智,你使用网易云信遇到任何问题,都可以问我哦",
        "imported": false
      }
    ]
  }
}
此文档是否对你有帮助?
有帮助
去反馈
  • 请求信息
  • 请求 URI
  • 请求头参数
  • 请求查询参数
  • 请求示例
  • 响应信息
  • 响应参数
  • 响应体示例