getAiVisualBoxInfo(params: GetAiVisualBoxInfoParams)

Requires:
@tuya-miniapp/cloud-api≥1.0.5

Description

Query Visual Cube info

Parameters

ParameterTypeRequiredDescription
YesRequest body

Return Value

Type: Promise<AiVisualBox>
Visual Cube details (AiVisualBox: add visionBoxId and serviceStockId to AiVisualBoxInfoContent)

Referenced Types

interfaceAiVisualBox
PropertyTypeDescription
visionBoxIdstringVision Cube ID
serviceStockIdstringAssociated service inventory ID
visionBoxNamestringVisual Cube name
visionBoxState0 | 1Vision Box status
generateDescState0 | 1Image-to-text switch
reportTypeListReportType[]Supported report type list
reportLangTypestringReport language type
Vision Box event list
sceneTypeSceneTypeScene type (Security/Album, etc.)
enumReportType
ValueActual ValueDescription
ReportType.DAILY1Daily report
ReportType.WEEKLY2Weekly report
enumVisionEventType
ValueActual ValueDescription
VisionEventType.PRESET0Preset event
VisionEventType.CUSTOM1Custom event
enumSceneType
ValueActual ValueDescription
SceneType.security0Security scenario
SceneType.album1Gallery scenario

Valid Values

AiVisualBox.visionBoxState
ValueDescriptionSince
0--
1--
AiVisualBox.generateDescState
ValueDescriptionSince
0--
1--
ReportType
ValueDescriptionSince
1Daily report-
2Weekly report-
VisionEventType
ValueDescriptionSince
0Preset event-
1Custom event-
SceneType
ValueDescriptionSince
0Security scenario-
1Gallery scenario-

Examples

Request example

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

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

Response example

{
  "visionBoxId": "vb-1",
  "visionBoxName": "Living Room Cube",
  "serviceStockId": "stock-1",
  "visionBoxState": 1,
  "generateDescState": 0,
  "reportTypeList": [1],
  "reportLangType": "zh",
  "visionBoxEventList": [],
  "sceneType": 0
}