Fanvue API icon

Fanvue API

Interact with the Fanvue API

Actions74

Chats → List Template Messages

AI-generated

Summary

List template messages in the Chats resource with pagination, folder filtering, and request configuration.

Inputs

  • X-Fanvue-API-Version (required) — API version to use for the request. Sent as the header X-Fanvue-API-Version. Default: 2025-06-26.
  • page — Page number to retrieve (starts from 1). Default: 1.
  • size — Number of items to return per page (1-50, default: 15).
  • folderName — Filter by folder name (case-insensitive partial match). Default: empty string (no filter).
  • requestOptions — Request configuration options including batching controls. Collection-type setting with placeholder 'Add Option'.
  • allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible. Default: false.
  • proxy — HTTP proxy to use. Supports authentication format http://username:password@myproxy:3128. Default: empty string.
  • timeout — Time in ms to wait for the server to send response headers before aborting the request. Min: 1. Default: 10000.

Output shape

The operation returns a paginated list of template messages under the Chats resource. Exact payload structure is not declared in the provided properties; refer to the node's runtime output for data format.

Pagination is controlled via page and size parameters. Folder filtering uses a case-insensitive partial match on folderName. Batching (when configured via requestOptions.batching) splits input into throttled batches controlled by batchSize and batchInterval.

Examples

Example 1: Retrieve the first page of 20 template messages from the Chats resource.

Set page to 1, size to 20, leave folderName empty, and use default API version.

Links

Discussion