TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node integrates with the TeleFlow API to perform various operations on multiple resource types, including files. Specifically, for the File - Get operation, it retrieves detailed information about a specific file resource by its unique identifier. This is useful when you need to fetch metadata or details of a particular file stored or managed within the TeleFlow system.

Common scenarios include:

  • Retrieving file details before processing or transferring.
  • Validating file existence and attributes in workflows.
  • Fetching additional file metadata to use in subsequent automation steps.

Example: You have a workflow that processes call recordings stored as files in TeleFlow. Before downloading or analyzing a recording, you use this node to get the file's metadata (like name, size, or type) by specifying its ID.

Properties

Name Meaning
ID The unique identifier of the file resource to retrieve. This is required to specify which file to get.
Fields Optional key-value pairs to filter or specify additional fields to include in the request. For example, you can add custom query parameters to refine the data returned by the API.

The "Fields" property allows adding multiple field-value pairs, where each pair consists of:

  • Name: The field name to filter or specify.
  • Value: The corresponding value for that field.

Output

The output is an array of JSON objects, each representing the retrieved file resource data from the TeleFlow API. The structure corresponds directly to the API response for a single file, typically including properties such as file ID, name, size, type, creation date, and other metadata.

If the API supports binary data for files, this node does not explicitly handle binary output in this operation; it returns JSON metadata only.

Dependencies

  • Requires an API key credential for authenticating with the TeleFlow API.
  • The base URL for the TeleFlow API must be configured in the node credentials.
  • The node uses HTTP requests to communicate with the TeleFlow REST API endpoints.

Troubleshooting

  • Missing ID error: If the "ID" property is not provided, the node will throw an error stating that the ID is required for the get operation. Ensure you provide a valid file ID.
  • API connection issues: Errors related to authentication or network connectivity may occur if the API key or base URL is incorrect or unreachable.
  • Invalid field filters: Providing unsupported or incorrect field names in the "Fields" property may result in incomplete or empty responses.
  • To resolve errors, verify the correctness of the input parameters, ensure the API credentials are valid, and check network access to the TeleFlow API endpoint.

Links and References

Discussion