getImageTransferNoteTemplateList(data?: GetImageTransferNoteTemplateListParams)

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

Description

Paginated query for note templates (filterable by category)

Parameters

ParameterTypeRequiredDescription
NoRequest parameters

Return Value

Type: Promise<GetImageTransferNoteTemplateListResult>
GetImageTransferNoteTemplateListResult paginated template result

Referenced Types

interfaceGetImageTransferNoteTemplateListResultResult of paginated query for note templates
PropertyTypeDescription
Template list
pageNonumberCurrent page number
pageSizenumberPage size
totalnumberTotal record count
hasMorebooleanWhether there is a next page

Valid Values

GetImageTransferNoteTemplateListResult.list.categoryType
ValueDescriptionSince
note--
family--
checklist--
reminder--
wordbook--
label--

Examples

Request example

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

getImageTransferNoteTemplateList({
  categoryId: 1,
  pageNo: 1,
  pageSize: 20,
})
  .then(response => {
    console.log(response);
  })
  .catch(error => {
    console.error('Failed to get note template list:', error);
  });

Response example

{
  "list": [
    {
      "id": 101,
      "tempCode": "cat-checklist-01",
      "name": "Simple Checklist",
      "categoryType": "checklist",
      "categoryIds": [1],
      "recommended": true,
      "deviceSupported": true,
      "svgUrl": "https://example.com/template.svg",
      "content": {},
      "background": {}
    }
  ],
  "pageNo": 1,
  "pageSize": 20,
  "total": 1,
  "hasMore": false
}

FAQ

Why does the call to cloud capabilities fail?

Before using this API, please ensure that the product to which the device belongs has enabled the Image Transfer advanced capability on the Tuya IoT Development Platform. Devices without this capability enabled cannot perform image upload or printing, and the API will return empty data or an error. If you need to use it, please create a product that supports image transfer/printing functions and enable the corresponding advanced capabilities in the product details. At the same time, the API depends on cloud capabilities, and authorization configuration is required in Development Settings - Cloud Capabilities on the Mini Program Developer Platform.