TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to perform various operations on different resources, including Carriers. Specifically, the "Get Many" operation for the Carrier resource retrieves multiple carrier records from the TeleFlow system. This is useful when you want to fetch a list of carriers with optional filtering based on specific fields.

Common scenarios include:

  • Retrieving all carriers available in the system.
  • Filtering carriers by certain attributes such as name or other custom fields.
  • Integrating carrier data into workflows for reporting, monitoring, or further processing.

For example, you might use this node to get all carriers whose name contains a particular string or match other criteria, then process that list downstream in your automation.

Properties

Name Meaning
Fields A collection of field-value pairs used to filter the query. You can specify multiple fields to narrow down the results. For each field, provide the field name and the value to filter by.

The "Fields" property allows adding multiple filters, each consisting of:

  • Name: The name of the field to filter on (e.g., "name").
  • Value: The value to match for that field.

Output

The output is an array of JSON objects representing the carriers retrieved from the TeleFlow API. Each object corresponds to a carrier record and includes all the fields returned by the API according to the specified filters.

The structure of each JSON object depends on the TeleFlow API response but generally includes carrier details such as identifiers, names, and other relevant attributes.

No binary data output is produced by this operation.

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 sends HTTP requests to the TeleFlow API endpoints.

Troubleshooting

  • Missing or invalid API credentials: Ensure that the API key and base URL are correctly set in the node credentials.
  • Invalid field names or values in filters: If the API returns errors or empty results, verify that the field names and values used in the "Fields" property are valid according to the TeleFlow API documentation.
  • Network issues or API downtime: Check network connectivity and TeleFlow service status if requests fail.
  • Error messages about missing IDs: Not applicable for "Get Many" operation but common in other operations like "Get" or "Update" where an ID is required.

If the node throws an error, enabling "Continue On Fail" will allow the workflow to proceed while capturing the error message in the output JSON.

Links and References

Discussion