getDeviceDetailsById(params: QueryGetDeviceDetailsById)

版本要求:
@tuya-miniapp/cloud-api≥1.0.5

描述

查看单个设备设备详情

参数

参数类型必填说明
是请求体

返回值

类型:Promise<DeviceDetails>
设备详情(见 DeviceDetails)

引用对象

interfaceDeviceDetails
属性类型描述
haveAvailableService0 | 1是否有可用服务(0 未开通、1 已开通)
activeStockIdListstring[]激活生效的服务 stockId 列表
productIdstring产品 id
设备服务计划列表
isUseFreeService0 | 1是否已购买订阅首期免费商品(0-未购买、1-已购买)
isUseCommonUserTrail0 | 1是否购买过普通试用-账号级别免费商品(0-未购买、1-已购买)
isUseCommonDeviceTrail0 | 1是否购买过普通试用-设备级别免费商品(0-未购买、1-已购买)
isTried0 | 1是否已试用商品(0-未试用、1-已试用)
hasServiceOrderboolean是否存在服务单
iconstring设备图标
namestring设备名称
ownerIdstring所属家庭 ID
uuidstring设备唯一 ID
roomNamestring房间名称
deviceIdstring设备 deviceId
isBindDeviceBindStatus绑定状态(已绑定 / 不支持 / 未绑定)
statusboolean设备状态
aiSmartFreeDevboolean当前设备是否处于 aiSmart 能力白名单中

合法值

DeviceDetails.haveAvailableService
值说明最低版本
0--
1--
DeviceDetails.planList.isSubscribe
值说明最低版本
0--
1--
DeviceDetails.planList.isCanceled
值说明最低版本
0--
1--
DeviceDetails.planList.isAdditional
值说明最低版本
0--
1--
DeviceDetails.isUseFreeService
值说明最低版本
0--
1--
DeviceDetails.isUseCommonUserTrail
值说明最低版本
0--
1--
DeviceDetails.isUseCommonDeviceTrail
值说明最低版本
0--
1--
DeviceDetails.isTried
值说明最低版本
0--
1--

示例代码

请求示例

import { getDeviceDetailsById } from '@tuya-miniapp/cloud-api';

getDeviceDetailsById({
  homeId: '194137',
  uuid: 'vdevo176127325226099',
  categoryCode: 'ipc',
})
  .then((detail) => {
    console.log(detail);
  })
  .catch((err) => {
    console.error(err);
  });

返回示例

{
  "uuid": "vdevo176127325226099",
  "name": "示例摄像头",
  "iconUrl": "https://images.example.com/icon.png",
  "online": true
}