getAlbumSetting(params: GetAlbumSettingReq)

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

Description

Time Album settings get API

Parameters

ParameterTypeRequiredDescription
YesRequest body

Return Value

Type: Promise<TimeAlbumSettingDto>
Album settings (TimeAlbumSettingDto: includes primary key id on TimeAlbumSettingPayload; the minituya response table has formatting errors—use types as the source of truth)

Referenced Types

interfaceTimeAlbumSettingDto
PropertyTypeDescription
idstringPrimary key ID
albumNamestringAlbum name
enableStatus0 | 1Enabled status
timedCaptureConfigstring[]Scheduled capture settings
Smart capture settings
enumVisionEventType
ValueActual ValueDescription
VisionEventType.PRESET0Preset event
VisionEventType.CUSTOM1Custom event

Valid Values

TimeAlbumSettingDto.enableStatus
ValueDescriptionSince
0--
1--
VisionEventType
ValueDescriptionSince
0Preset event-
1Custom event-

Examples

Request example

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

getAlbumSetting({ stockId: '1', gid: '194137' })
  .then((cfg) => console.log(cfg))
  .catch(console.error);

Response example

{
  "id": "album-1",
  "albumName": "Nursery",
  "enableStatus": 1,
  "timedCaptureConfig": ["12:00"],
  "smartCaptureConfig": [
    { "eventCode": "person", "eventValue": "1", "eventType": 0 }
  ]
}