TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

The node interacts with the TeleFlow API to perform various operations on different resources, including "Voice". Specifically, for the "Voice" resource with the "Get Many" operation, it retrieves multiple voice records from the TeleFlow system. This is useful when you want to fetch a list of voice entries filtered by specific criteria.

Common scenarios include:

  • Retrieving all voice records or a subset based on certain fields.
  • Filtering voice data by attributes such as name or other custom fields.
  • Integrating voice data retrieval into automated workflows for reporting or further processing.

Example: You might use this node to get all voice records where the "status" field equals "active" to process only currently active voice entries.

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 example, you might specify name = "John" or any other relevant field supported by the API.

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

  • Name: The field name to filter by (string).
  • Value: The value to match for that field (string).

Output

The output is an array of JSON objects representing the voice records retrieved from the TeleFlow API. Each item in the output corresponds to one voice record and contains all the fields returned by the API for that record.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the TeleFlow API.
  • The base URL for the 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.
  • Empty or no results returned: Check the filter fields provided; incorrect field names or values may result in no matches.
  • API errors: If the API returns an error, the node will throw an error unless "Continue On Fail" is enabled, in which case the error message will be included in the output JSON under an error property.
  • Field validation: Make sure the field names used in the "Fields" property correspond exactly to those accepted by the TeleFlow API for the Voice resource.

Links and References

Discussion