TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node allows interaction with the TeleFlow API to manage various resources, including LCR (Least Cost Routing) entries. Specifically, the Get operation for the LCR resource retrieves detailed information about a single LCR entry by its unique ID. This is useful when you need to fetch specific routing configurations or details stored in TeleFlow for further processing or decision-making within your workflows.

Practical examples include:

  • Retrieving an LCR entry to verify its configuration before applying changes.
  • Fetching LCR details to use them as input parameters for other nodes or systems.
  • Auditing or reporting on specific LCR entries by their IDs.

Properties

Name Meaning
ID The unique identifier of the LCR resource to retrieve. This is required for the Get operation.
Fields Optional field-value pairs to filter or specify additional query parameters for the request. You can add multiple fields, each with a name and value, to refine the data returned by the API.

Output

The output is a JSON object representing the retrieved LCR resource. It contains all the properties and values as returned by the TeleFlow API for that specific LCR entry. The exact structure depends on the API response but typically includes identifiers, routing rules, priorities, and other relevant LCR configuration details.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the TeleFlow API via an API key credential configured in n8n.
  • The base URL for the TeleFlow API must be set in the node credentials.
  • The node uses HTTP requests with JSON content type and expects JSON responses.

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 LCR ID.
  • API Connection Issues: Errors related to network connectivity, invalid credentials, or incorrect base URL may occur. Verify your API key and endpoint configuration.
  • Invalid Field Names: Providing incorrect or unsupported field names in the "Fields" property may result in unexpected API responses or errors. Double-check the field names against the TeleFlow API documentation.
  • Continue On Fail: If enabled, the node will continue processing subsequent items even if one fails, returning the error message in the output JSON.

Links and References

Discussion