输入关键词搜索

按设备 ID 获取设备

更新时间: 2025/10/31 15:57:03

按设备 ID 获取设备信息。

功能说明

根据设备 ID 获取指定设备的详细信息,包括设备归属用户、关联代理等信息。

请求信息

请求 URI

GET https://rtc-agent.yunxinapi.com/v1/device/getDevice

请求头参数

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

请求查询参数

参数名称 类型 是否必选 示例 说明
deviceId String device1 设备 ID

响应信息

响应参数

参数名称 类型 说明 是否必返回
code Integer 状态码,200 表示请求成功
message String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
requestId String 请求的唯一标识 ID
- data Object 响应数据
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": {
        "deviceId": "device1",
        "userId": "user1",
        "agentId": "99b6176cf",
        "agentName": "设备名称",
        "createdAt": 1751107896000,
        "updatedAt": 1751107896000,
        "customProperties": [
            {
            "key": "deviceType",
            "value": "smartSpeaker"
            }]
    },
    "success": true
}
此文档是否对你有帮助?
有帮助
去反馈
  • 功能说明
  • 请求信息
  • 请求 URI
  • 请求头参数
  • 请求查询参数
  • 响应信息
  • 响应参数
  • 响应体示例