TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

The node interacts with the TeleFlow API to perform various operations on different resources. Specifically, for the Number Port resource and the Get Many operation, it retrieves multiple number port records from the TeleFlow system. This is useful when you want to fetch a list of number ports filtered by specific criteria.

Common scenarios include:

  • Retrieving all number port requests or entries in your TeleFlow account.
  • Filtering number ports based on certain fields such as status, date, or other attributes.
  • Integrating TeleFlow number port data into workflows for reporting or further processing.

Example: You might use this node to get all number ports that match certain conditions (e.g., only those with a particular status) and then process or analyze them downstream in your workflow.

Properties

Name Meaning
Fields A collection of field-value pairs to filter the request. You can specify multiple fields to narrow down the query results. For example, you might filter by "status" or "date".

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

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

Output

The output is an array of JSON objects representing the number port records retrieved from the TeleFlow API. Each object corresponds to one number port entry with its associated properties as returned by the API.

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 uses HTTP requests to communicate with the TeleFlow REST API endpoints.

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; overly restrictive filters may return no data.
  • Error messages about missing ID: Not applicable for "Get Many" but relevant for other operations like "Get" or "Update" where an ID is required.
  • HTTP errors: Network issues or incorrect API endpoint configuration can cause failures. Verify connectivity and API access permissions.
  • If the node is set to continue on fail, errors will be returned in the output JSON under an error property.

Links and References

Discussion