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.

Practical examples include:

  • Retrieving all carriers available in your TeleFlow account.
  • Filtering carriers by certain attributes such as name or other custom fields to narrow down the results.
  • Using the retrieved carrier data for further processing or integration workflows within n8n.

Properties

Name Meaning
Fields A collection of field-value pairs used to filter the query. You can specify multiple fields to refine the search criteria. For example, you might filter carriers by their name or other attributes.

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

  • Name: The field name to filter by (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 contains the carrier's details as returned by the API, which may include identifiers, names, and other carrier-specific information.

No binary data is output by this node.

Example output structure (simplified):

[
  {
    "id": "carrier-id-1",
    "name": "Carrier One",
    "otherField": "value"
  },
  {
    "id": "carrier-id-2",
    "name": "Carrier Two",
    "otherField": "value"
  }
]

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.

Troubleshooting

  • Missing or invalid API credentials: Ensure that the API key and base URL are correctly set in the node credentials.
  • Invalid field names in filters: If you specify field names that do not exist or are misspelled, the API may return errors or empty results. Verify field names against TeleFlow API documentation.
  • Empty results: If no carriers match the specified filters, the output will be an empty array.
  • Network issues or API downtime: Check network connectivity and TeleFlow service status if requests fail.

Common error message:

  • "ID is required for get/update/delete operations" — This does not apply to "Get Many" but indicates that some operations require an ID parameter.

Links and References

Discussion