TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node integrates with the TeleFlow API to perform various operations on multiple resources, including Flow Templates. Specifically, for the "Flow Template" resource and the "Get" operation, it retrieves detailed information about a specific flow template by its unique identifier. This is useful in scenarios where you need to fetch configuration or metadata of a particular flow template within your telephony or workflow automation system.

Practical examples include:

  • Retrieving a flow template's details to display or process them in subsequent workflow steps.
  • Validating the existence or properties of a flow template before performing updates or deletions.
  • Extracting specific fields from a flow template for reporting or auditing purposes.

Properties

Name Meaning
ID The unique identifier of the flow template to retrieve. This is required.
Fields Optional key-value pairs specifying additional fields to include in the request query string. You can add multiple field name and value pairs to filter or customize the data returned.

Output

The node outputs an array of JSON objects, each representing the response from the TeleFlow API for the requested flow template. The JSON structure corresponds directly to the flow template's data as returned by the API, including all requested fields.

No binary data output is produced by this operation.

Example output snippet (conceptual):

{
  "id": "template123",
  "name": "Sample Flow Template",
  "description": "A description of the flow template",
  "createdAt": "2024-01-01T12:00:00Z",
  ...
}

Dependencies

  • Requires an API authentication token credential configured in n8n to access the TeleFlow API.
  • The base URL for the TeleFlow API must be set in the node credentials.
  • The node uses HTTP requests to communicate with the TeleFlow API endpoints.

Troubleshooting

  • Missing ID error: If the "ID" property is not provided for the get operation, the node will throw an error stating that the ID is required. Ensure you provide a valid flow template ID.
  • API connection issues: Errors related to network connectivity or invalid credentials may occur. Verify that the API key/token and base URL are correctly configured.
  • Invalid field names: If you specify fields that do not exist or are unsupported by the API, the request might fail or return incomplete data. Double-check field names against the TeleFlow API documentation.
  • Continue on Fail: If enabled, the node will continue processing other items even if one fails, returning error messages in the output JSON under an error key.

Links and References

Discussion