---
name: "getVisualBoxList"
mode: "kit"
versionRequirements:
  - { name: "@tuya-miniapp/cloud-api", version: "1.0.5" }
---

## getVisualBoxList

> [VERSION] @tuya-miniapp/cloud-api >= 1.0.5

### 方法签名

```typescript
getVisualBoxList(params: QueryGetAiVisualList)
```

### 描述

查询智能视觉魔方列表（关联服务）

### 参数

`Params`

| 参数 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `params` | `QueryGetAiVisualList` | 是 | - | 请求体 |

### 返回值

类型: `Promise<VisionBoxDto[]>`

VisionBoxDto 数组

### 引用对象

##### `type` QueryGetAiVisualList

| 属性 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `gid` | `string` | 是 | 家庭 gid |

##### `interface` VisionBoxDto

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `visionBoxId` | `string` | 视觉魔方 id |
| `visionBoxName` | `string` | 视觉魔方名称 |
| `gmtCreate` | `string` | 创建时间 |
| `serviceStockId` | `string` | 关联服务库存 id |
| `serviceName` | `string` | 服务名称 |
| `enableState` | `number` | 启用状态 |
| `expiredTime` | `number` | 过期时间 |
| `scenesType` | `"SceneType.security" \\| "SceneType.album"` | 场景类型 |

##### `enum` SceneType

| 枚举值 | 实际值 | 描述 |
| --- | --- | --- |
| `SceneType.security` | `0` | 安防场景 |
| `SceneType.album` | `1` | 相册场景 |


### 合法值

##### `SceneType`

| 值 | 说明 | 最低版本 |
| --- | --- | --- |
| `0` | 安防场景 | - |
| `1` | 相册场景 | - |


### 示例代码

#### 请求示例

```typescript
import { getVisualBoxList } from '@tuya-miniapp/cloud-api';

getVisualBoxList({ gid: '194137' })
  .then((list) => console.log(list))
  .catch(console.error);
```

#### 返回示例

```json
[
  {
    "visionBoxId": "vb-1",
    "visionBoxName": "客厅魔方",
    "gmtCreate": "2024-01-01 10:00:00",
    "serviceStockId": "stock-1",
    "serviceName": "智能视觉",
    "enableState": 1,
    "expiredTime": 1735660800000,
    "scenesType": 0
  }
]
```
