getAiVisualBoxInfo(params: GetAiVisualBoxInfoParams)

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

描述

查询视觉魔方信息

参数

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

返回值

类型：Promise<AiVisualBox>
视觉魔方详情（AiVisualBox：在 AiVisualBoxInfoContent 上增加 visionBoxId、serviceStockId）

引用对象

interfaceAiVisualBox
属性类型描述
visionBoxIdstring视觉魔方 id
serviceStockIdstring关联服务库存 id
visionBoxNamestring视觉魔方名称
visionBoxState0 | 1视觉魔方状态
generateDescState0 | 1图生文开关
reportTypeListReportType[]支持的报告类型列表
reportLangTypestring报告语言类型
视觉魔方事件列表
sceneTypeSceneType场景类型（安防 / 相册等）
enumReportType
枚举值实际值描述
ReportType.DAILY1日报
ReportType.WEEKLY2周报
enumVisionEventType
枚举值实际值描述
VisionEventType.PRESET0预置事件
VisionEventType.CUSTOM1自定义事件
enumSceneType
枚举值实际值描述
SceneType.security0安防场景
SceneType.album1相册场景

合法值

AiVisualBox.visionBoxState
值说明最低版本
0--
1--
AiVisualBox.generateDescState
值说明最低版本
0--
1--
ReportType
值说明最低版本
1日报-
2周报-
VisionEventType
值说明最低版本
0预置事件-
1自定义事件-
SceneType
值说明最低版本
0安防场景-
1相册场景-

示例代码

请求示例

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

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

返回示例

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