小智Pro

Appearance

设备相关API ​

INFO

本文档描述了用户获取设备相关信息的API接口，支持查询设备列表、下载、删除聊天记录等功能。

1. 查询设备列表 ​

查询当前用户名下所有设备列表。

基本信息 ​

  • 接口路径: /xiaozhi/device/list
  • 请求方法: GET
  • 认证方式: API Key

请求参数 (Query Parameters) ​

参数名类型必填默认值说明
pageinteger否1页码
page_sizeinteger否10每页数量

响应示例 ​

json
{
  "code": 200,
  "data": [
    {
      "id": 1,
      "device_id": "00:11:22:33:44:55"
    }
  ],
  "total": 10,
  "page": 1,
  "page_size": 10,
  "msg": "success"
}

2. 下载聊天记录 ​

获取指定设备的聊天记录。

基本信息 ​

  • 接口路径: /xiaozhi/conversation/list
  • 请求方法: GET
  • 认证方式: API Key

请求参数 (Query Parameters) ​

参数名类型必填默认值说明
pageinteger否1页码
page_sizeinteger否10每页数量
device_idstring是-设备 MAC 地址

响应示例 ​

json
{
  "code": 200,
  "data": [
    {
      "id": 1,
      "device_id": "b4:3a:45:f3:9a:5c",
      "summary": "设备绑定中",
      "conversation": [
        {
          "stt": "Hi, 小智 ",
          "tts": "嗨～在的喔！ 有什么我可以帮你的吗？ "
        },
        {
          "stt": "电设备。 ",
          "tts": "你是想说"电子设备"吗？ 还是想控制什么呀～？ "
        }
      ],
    }
  ],
  "total": 1,
  "page": 1,
  "page_size": 10,
  "msg": "success"
}

3. 删除聊天记录 ​

删除指定 device_id 或 id 的聊天记录。

基本信息 ​

  • 接口路径: /xiaozhi/conversation/delete
  • 请求方法: DELETE
  • 认证方式: API Key

请求参数 (Query Parameters) ​

参数名类型必填默认值说明
idinteger否-对话ID，如果提供则删除单条记录
device_idstring否-设备 MAC 地址，如果提供则删除该设备的所有记录

WARNING

注：id 和 device_id 两个参数二选一，不能同时为空

响应示例 ​

json
{
  "code": 200,
  "data": null,
  "msg": "Deleted Successfully"
}