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.

Common scenarios include:

  • Retrieving configuration details of an LCR entry before making changes.
  • Fetching LCR data to use in workflows that depend on routing rules.
  • Auditing or reporting on specific LCR entries.

Example: You have an LCR ID and want to get all its properties to verify or display them in your workflow.

Properties

Name Meaning
ID The unique identifier of the LCR resource to retrieve. 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.

Output

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

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the TeleFlow API.
  • Needs an API authentication token configured in the node credentials.
  • The base URL for the TeleFlow API must be set in the credentials.

Troubleshooting

  • Missing ID Error: If the "ID" property is not provided, the node will throw an error stating that the ID is required. Ensure you provide a valid LCR ID.
  • API Connection Issues: Network errors or invalid credentials will cause HTTP request failures. Verify your API key and base URL.
  • Invalid Field Names: Providing incorrect field names in the "Fields" property may result in unexpected API responses or errors. Use only supported field names as per TeleFlow API documentation.
  • Continue On Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

Links and References

Discussion