设备工具描述API

设备工具描述API用于管理并自定义当前用户的设备工具描述。

使用说明

不同设备支持的工具可能不同，请填写设备实际上报的工具名称。

1. 查询设备工具描述

查询设备工具描述

获取当前用户已配置的设备工具描述列表。

GEThttps://xrobo.qiniu.com/v1/device/tools

点击展开

基本信息

Host:https://xrobo.qiniu.com

Base Path:/v1

Method:GET

返回类型:application/json

请求头

Header名类型必填说明

Authorizationstring是Bearer token认证

响应示例

{
  "code": 0,
  "data": {
    "tools": [
      {
        "id": "9f4b1d7c2e8a4f5b9c0d1e2f3a4b5c6d",
        "name": "self.audio_speaker.set_volume",
        "desc": "设置音量。",
        "updated_at": "2026-06-10T14:30:00+08:00"
      }
    ]
  }
}

状态码

0查询成功

2. 新增设备工具描述

新增设备工具描述

POSThttps://xrobo.qiniu.com/v1/device/tools

点击展开

基本信息

Host:https://xrobo.qiniu.com

Base Path:/v1

Method:POST

返回类型:application/json

请求参数

参数名类型必填位置说明

namestring是-设备工具名称

descstring是-自定义工具描述，最长200个字符

请求头

Header名类型必填说明

Authorizationstring是Bearer token认证

Content-Typestring是请求内容类型

请求示例

{
  "name": "self.audio_speaker.set_volume",
  "desc": "设置音量。"
}

响应示例

{
  "code": 0,
  "data": {
    "id": "9f4b1d7c2e8a4f5b9c0d1e2f3a4b5c6d",
    "name": "self.audio_speaker.set_volume",
    "desc": "设置音量。",
    "updated_at": "2026-06-10T14:30:00+08:00"
  }
}

状态码

0新增成功

400请求参数错误

614同一用户已配置相同工具名称

3. 更新设备工具描述

更新设备工具描述

PUThttps://xrobo.qiniu.com/v1/device/tools/{id}

点击展开

基本信息

Host:https://xrobo.qiniu.com

Base Path:/v1

Method:PUT

返回类型:application/json

请求参数

参数名类型必填位置说明

idstring是-设备工具描述配置ID，由查询、新增或更新接口返回

namestring是-设备工具名称

descstring是-自定义工具描述，最长200个字符

请求头

Header名类型必填说明

Authorizationstring是Bearer token认证

Content-Typestring是请求内容类型

请求示例

{
  "name": "self.audio_speaker.set_volume",
  "desc": "设置音量。"
}

响应示例

{
  "code": 0,
  "data": {
    "id": "9f4b1d7c2e8a4f5b9c0d1e2f3a4b5c6d",
    "name": "self.audio_speaker.set_volume",
    "desc": "设置音量。",
    "updated_at": "2026-06-10T14:30:00+08:00"
  }
}

状态码

0更新成功

400请求参数错误

612配置不存在，或配置不属于当前用户

614同一用户已配置相同工具名称

4. 删除设备工具描述

删除设备工具描述

DELETEhttps://xrobo.qiniu.com/v1/device/tools/{id}

点击展开

基本信息

Host:https://xrobo.qiniu.com

Base Path:/v1

Method:DELETE

返回类型:application/json

请求参数

参数名类型必填位置说明

idstring是-设备工具描述配置ID，由查询、新增或更新接口返回

请求头

Header名类型必填说明

Authorizationstring是Bearer token认证

响应示例

{
  "code": 0,
  "data": null
}

状态码

0删除成功

612配置不存在，或配置不属于当前用户