文档中心

Appearance

聊天记录 API ​

获取聊天记录列表 ​

获取聊天记录列表

获取指定智能体的聊天会话列表，支持分页查询

GEThttps://xrobo.qiniu.com/xiaozhi/agent/{agentId}/sessions
点击展开

基本信息

Host:https://xrobo.qiniu.com
Base Path:/xiaozhi
Method:GET
返回类型:application/json

请求参数

参数名类型必填位置说明
agentIdstring是path智能体ID
pageinteger否query页码，从1开始
limitinteger否query每页记录数

请求头

Header名类型必填说明
Authorization是用户认证令牌，格式为 Bearer + 空格 + token

请求示例 

GET /xiaozhi/agent/09689edfb5a74846ad8f2a6512c26a73/sessions?page=1&limit=20 HTTP/1.1
Host: https://xrobo.qiniu.com
Authorization: Bearer <token>

响应示例 

{
  "code": 0,
  "msg": "success",
  "data": {
    "total": 139,
    "list": [
      {
        "sessionId": "7465966b-4582-4dae-99be-420364d422d7",
        "createdAt": "2025-08-28 16:02:49",
        "chatCount": 75
      },
      {
        "sessionId": "9eab0c2b-79c0-402c-a695-09d802bd977a",
        "createdAt": "2025-08-28 12:25:01",
        "chatCount": 3
      },
      ...(limit=20, 共20条)
    ]
  }
}

状态码

0OK - 成功获取聊天记录列表
401Unauthorized - 未登录或token无效

INFO

响应中的list包含会话的基本信息，包括sessionId、创建时间和聊天数量。total表示总记录数。

获取聊天记录详情 ​

获取聊天记录详情

获取指定智能体和会话的详细聊天记录

GEThttps://xrobo.qiniu.com/xiaozhi/agent/{agentId}/chat-history/{sessionId}
点击展开

基本信息

Host:https://xrobo.qiniu.com
Base Path:/xiaozhi
Method:GET
返回类型:application/json

请求参数

参数名类型必填位置说明
agentIdstring是path智能体ID
sessionIdstring是path会话ID

请求头

Header名类型必填说明
Authorization是用户认证令牌，格式为 Bearer + 空格 + token

请求示例 

GET /xiaozhi/agent/09689edfb5a74846ad8f2a6512c26a73/chat-history/7465966b-4582-4dae-99be-420364d422d7 HTTP/1.1
Host: https://xrobo.qiniu.com
Authorization: Bearer <token>

响应示例 

{
  "code": 0,
  "msg": "success",
  "data": [
    {
      "createdAt": "2025-08-28 15:57:16",
      "chatType": 1,
      "content": "那你西啊，帮我邀请一下大家来参加我们的展会。😊",
      "audioId": "aa2f6e1aadde09585e7a2acd165dfe9e",
      "macAddress": "09689edfb5a74846ad8f2a6512c26a73"
    },
    {
      "createdAt": "2025-08-28 15:57:19",
      "chatType": 1,
      "content": "这个有意思多了。😊",
      "audioId": "e8d7f48c8a30473279f4bf9c714bc3ae",
      "macAddress": "09689edfb5a74846ad8f2a6512c26a73"
    },
    ...
  ]
}

状态码

0OK - 成功获取聊天记录列表
401Unauthorized - 未登录或token无效

INFO

响应中的data是一个聊天消息数组，按时间顺序排列，每条消息包含创建时间、聊天类型、内容、音频ID和MAC地址。

获取对话音频的播放ID ​

获取对话音频的播放ID

通过音频ID（从聊天记录详情中获取）获取对应的播放ID，用于后续播放音频

GEThttps://xrobo.qiniu.com/xiaozhi/agent/audio/{audioId}
点击展开

基本信息

Host:https://xrobo.qiniu.com
Base Path:/xiaozhi
Method:GET
返回类型:application/json

请求参数

参数名类型必填位置说明
audioIdstring是path音频ID，从聊天记录详情中获取

请求头

Header名类型必填说明
Authorization是用户认证令牌，格式为 Bearer + 空格 + token

请求示例 

GET /xiaozhi/agent/audio/d9b8fdbc0ce492a0feb7a87e92c4eaf5 HTTP/1.1
Host: https://xrobo.qiniu.com
Authorization: Bearer <token>

响应示例 

{
  "code": 0,
  "msg": "success",
  "data": "a040a914-ba53-42f4-a878-08293bf5877a"
}

状态码

0OK - 成功获取聊天记录列表
401Unauthorized - 未登录或token无效

INFO

此接口用于获取播放ID，应与播放对话音频接口一同使用。

播放对话音频 ​

播放对话音频

通过播放ID下载音频文件，返回二进制音频数据，支持直接播放或下载

GEThttps://xrobo.qiniu.com/xiaozhi/agent/play/{playId}
点击展开

基本信息

Host:https://xrobo.qiniu.com
Base Path:/xiaozhi
Method:GET
返回类型:application/json

请求参数

参数名类型必填位置说明
playIdstring是path播放ID，从获取音频对应的播放ID接口中获取

请求头

Header名类型必填说明
Authorization是用户认证令牌，格式为 Bearer + 空格 + token

请求示例 

GET /xiaozhi/agent/play/a040a914-ba53-42f4-a878-08293bf5877a HTTP/1.1
Host: https://xrobo.qiniu.com
Authorization: Bearer <token>

响应示例 

HTTP/1.1 200 OK
Content-Disposition: attachment; filename="play.wav"
Content-Length: 7724
Content-Type: application/octet-stream

[Binary audio data]

状态码

0OK - 操作成功
401Unauthorized - 未登录或token无效

INFO

响应为二进制音频文件（WAV格式），可用于下载或直接播放。此接口应与获取音频对应的播放ID接口一同使用。