TeleFlow icon

TeleFlow

Interact with TeleFlow API

Actions82

Overview

This node integrates with the TeleFlow API, allowing users to perform CRUD (Create, Read, Update, Delete) operations on various TeleFlow resources such as accounts, devices, phone numbers, SIP trunks, users, tenants, and more. It is useful for automating management tasks within the TeleFlow platform, such as creating new accounts or devices, retrieving details of existing entities, updating configurations, or deleting records.

Practical examples include:

  • Automatically provisioning new phone numbers or devices when onboarding new employees.
  • Fetching detailed account or user information for reporting or auditing purposes.
  • Updating device or user settings in bulk based on external triggers.
  • Removing obsolete or inactive resources programmatically.

Properties

Name Meaning
Fields A collection of field-value pairs to include as query parameters in GET requests. Users can add multiple fields to filter or specify which data to retrieve.

Note: The node also supports other input properties depending on the resource and operation selected, such as name, type, number, host, username, email, and id. These are used to provide necessary data for create, update, get, and delete operations.

Output

The node outputs an array of items where each item contains a json property holding the response from the TeleFlow API. The structure of this JSON depends on the resource and operation performed:

  • For create operations, it returns the newly created resource object.
  • For get operations, it returns the specific resource object identified by ID.
  • For getAll operations, it returns a list or collection of resource objects matching the query.
  • For update operations, it returns the updated resource object.
  • For delete operations, it returns the API's deletion confirmation response.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the TeleFlow API.
  • The base URL for the TeleFlow API must be configured in the credentials.
  • The node uses HTTP requests with JSON payloads and expects JSON responses.
  • No additional external dependencies beyond the TeleFlow API and n8n's HTTP request helper.

Troubleshooting

  • Missing ID for get/update/delete operations: The node throws an error if the required resource ID parameter is not provided. Ensure that the ID is specified when performing these operations.
  • API authentication errors: If the API key or base URL is incorrect or missing, requests will fail. Verify credential configuration.
  • Invalid field names or values: When specifying fields for filtering or querying, ensure they match the TeleFlow API's expected parameters.
  • Network or connectivity issues: Standard HTTP errors may occur if the TeleFlow API is unreachable; check network access and API status.
  • Continue on Fail behavior: If enabled, errors for individual items will be captured in the output JSON under an error property instead of stopping execution.

Links and References

Discussion