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

## getAiVisualBoxInfo

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

### 描述

查询视觉魔方信息

### 参数

`Params`

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

### 引用对象

##### `type` GetAiVisualBoxInfoParams

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `stockId` | `string` | 库存 id |
| `visionBoxId` | `string` | 视觉魔方 id（可选） |
| `gid` | `string` | 家庭 gid |

##### `enum` ReportType

| 枚举值 | 实际值 | 描述 |
| --- | --- | --- |
| `ReportType.DAILY` | `1` | 日报 |
| `ReportType.WEEKLY` | `2` | 周报 |

##### `interface` VisionBoxEvent

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `eventCode` | `string` | 事件编码 |
| `eventValue` | `string` | 事件取值 |
| `eventType` | `"VisionEventType.PRESET" \\| "VisionEventType.CUSTOM"` | 事件类型（预置 / 自定义） |

##### `enum` SceneType

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

##### `enum` VisionEventType

| 枚举值 | 实际值 | 描述 |
| --- | --- | --- |
| `VisionEventType.PRESET` | `0` | 预置事件 |
| `VisionEventType.CUSTOM` | `1` | 自定义事件 |


### 示例代码

#### 请求示例

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

getAiVisualBoxInfo({ gid: '194137', stockId: 'stock-1', visionBoxId: 'vb-1' })
  .then((box) => console.log(box))
  .catch(console.error);
```

#### 返回示例

```json
{
  "visionBoxId": "vb-1",
  "visionBoxName": "客厅魔方",
  "serviceStockId": "stock-1",
  "visionBoxState": 1,
  "generateDescState": 0,
  "reportTypeList": [1],
  "reportLangType": "zh",
  "visionBoxEventList": [],
  "sceneType": 0
}
```