获取设备列表
更新时间: 2025/10/31 15:56:52
通过该接口,您可以获取指定条件下的设备列表信息,支持按照 Agent ID 或用户 ID 进行筛选查询。
功能描述
- 支持获取所有设备列表或按条件筛选。
- 支持按 Agent ID 筛选设备。
- 支持按用户 ID 筛选设备。
- 支持分页查询。
请求信息
请求 URI
GET https://rtc-agent.yunxinapi.com/v1/device/list
请求头参数
请求 Header 的参数说明请参考 请求结构。
请求查询参数
| 参数名称 | 类型 | 是否必选 | 示例 | 说明 |
|---|---|---|---|---|
| agentId | String | 否 | 99b6176cf | Agent ID,用于筛选指定 Agent 下的设备 |
| userId | String | 否 | user1 | 用户 ID,用于筛选指定用户的设备 |
| page | Integer | 否 | 1 | 页码,从 1 开始,默认为 1 |
| pageSize | Integer | 否 | 10 | 每页条数,默认为 10,最大为 100 |
响应信息
响应参数
| 参数名称 | 类型 | 说明 | 是否必返回 |
|---|---|---|---|
| code | Integer | 状态码,200 表示请求成功 | 是 |
| message | String | 提示信息,请求失败时返回错误信息,请求成功时返回 "success" | 是 |
| requestId | String | 请求的唯一标识 ID | 是 |
| - data | Object | 响应数据 | 是 |
| - devices | Array | 设备列表 | 是 |
| deviceId | String | 设备 ID | 是 |
| userId | String | 用户 ID | 是 |
| agentId | String | Agent ID | 是 |
| agentName | String | Agent 名称 | 是 |
| createdAt | Long | 创建时间戳,单位毫秒 | 是 |
| updatedAt | Long | 更新时间戳,单位毫秒 | 是 |
| - customProperties | Array | 设备的自定义属性,用于在 MCP 调用中传递设备信息 | 否 |
| key | String | 自定义属性的名称 | 否 |
| value | String | 自定义属性的值 | 否 |
| success | Boolean | 操作是否成功 | 是 |
响应体示例
JSON{
"code": 200,
"message": "操作成功",
"requestId": "ai56f35572d3174c45b2ce383297e1847a",
"data": {
"devices": [
{
"deviceId": "device1",
"userId": "user1",
"agentId": "99b6176cf",
"agentName": "智能设备 A",
"createdAt": 1751107896000,
"updatedAt": 1751107896000,
"customProperties": [
{
"key": "deviceType",
"value": "smartSpeaker"
}]
},
{
"deviceId": "device2",
"userId": "user2",
"agentId": "88a5165be",
"agentName": "智能设备 B",
"createdAt": 1751107900000,
"updatedAt": 1751107900000,
"customProperties": [
{
"key": "location",
"value": "livingroom"
}]
}
]
},
"success": true
}
此文档是否对你有帮助?





