TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to manage various resources, including Carriers. Specifically, the Delete operation for the Carrier resource allows users to remove a carrier entry from their TeleFlow system by specifying its unique ID.

Common scenarios where this node is beneficial include:

  • Automating cleanup of obsolete or incorrect carrier records.
  • Integrating TeleFlow carrier management into broader workflows that maintain telephony infrastructure.
  • Programmatically managing carriers without manual intervention in the TeleFlow UI.

For example, a user might set up a workflow that deletes carriers flagged as inactive in an external system, ensuring the TeleFlow database stays current.

Properties

Name Meaning
ID The unique identifier of the carrier resource to delete. This is required.
Fields Optional field-value pairs to include in the request for more specific queries (not used in Delete but available for other operations).

Output

The output JSON contains the response from the TeleFlow API after attempting to delete the specified carrier. Typically, this will be a confirmation of deletion or an error message if the deletion failed.

No binary data is output by this node.

Example output structure:

{
  "json": {
    // API response confirming deletion or error details
  }
}

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 endpoints.

Troubleshooting

  • Missing ID Error: If the "ID" property is not provided, the node throws an error stating that the ID is required for the delete operation. Ensure you provide a valid carrier ID.
  • API Errors: If the API returns an error (e.g., invalid ID, permission issues), the node will throw an error unless "Continue On Fail" is enabled, in which case it outputs the error message in the JSON.
  • Network Issues: Connectivity problems or incorrect base URL configuration can cause request failures. Verify network access and credential settings.
  • Permission Denied: Ensure the API key has sufficient permissions to delete carrier resources.

Links and References

Discussion