TeleFlow icon

TeleFlow

Interact with TeleFlow API
Join our community

Actions145

Overview

This node interacts with the TeleFlow API to manage various resources, including flows. Specifically, the Flow - Delete operation allows users to delete a flow resource by specifying its unique identifier (ID). This is useful in scenarios where you want to programmatically remove obsolete or unwanted flows from your TeleFlow system as part of an automated workflow.

Practical examples:

  • Automatically deleting flows that are no longer needed after a certain event.
  • Cleaning up test or temporary flows created during development or testing phases.
  • Integrating flow deletion into larger automation processes for managing telephony configurations.

Properties

Name Meaning
ID The unique identifier of the flow resource to delete. Required to specify which flow to remove.
Fields Optional field-value pairs to include in the request for more specific queries (not typically 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 flow. Typically, this will be a confirmation of deletion or an empty object if successful. If the deletion fails, the output may contain error details.

No binary data output is produced by this operation.

Example output JSON might look like:

{
  "success": true,
  "message": "Flow deleted successfully"
}

or simply an empty JSON object {} depending on the API response.

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 DELETE requests to the endpoint /flows/{id} to perform the deletion.

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 flow ID.
  • API Authentication Errors: If the API key or base URL is incorrect or missing, the node will fail to authenticate. Verify your credentials and configuration.
  • Resource Not Found: If the specified flow ID does not exist, the API may return a 404 error. Confirm the ID is correct and the flow exists.
  • Permission Issues: Insufficient permissions for the API key can cause authorization errors. Make sure the API key has rights to delete flows.
  • Network Issues: Connectivity problems can cause request failures. Check network access to the TeleFlow API endpoint.

If continueOnFail is enabled, errors will be returned in the output JSON under an error field instead of stopping execution.

Links and References

Discussion