TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to perform CRUD (Create, Read, Update, Delete) operations on various resources, including Tariff Profiles. Specifically, for the Delete operation on a Tariff Profile, it deletes a tariff profile resource identified by its unique ID.

Common scenarios where this node is beneficial include automating the management of telephony-related configurations such as tariff profiles, accounts, devices, and phone numbers within the TeleFlow system. For example, you might use this node to programmatically remove obsolete or incorrect tariff profiles as part of a cleanup workflow.

Practical example: Automatically deleting a tariff profile when it is no longer needed after migrating customers to a new pricing plan.

Properties

Name Meaning
ID The unique identifier of the Tariff Profile 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 is a JSON object representing the response from the TeleFlow API after attempting to delete the specified Tariff Profile. Typically, this will confirm successful deletion or provide error details if the operation failed.

No binary data output is produced by this node.

Example output JSON structure after deletion:

{
  "success": true,
  "message": "Tariff Profile deleted successfully"
}

or in case of failure:

{
  "error": "Resource not found or already deleted"
}

Dependencies

  • Requires an active connection to the TeleFlow API.
  • Needs an API authentication token or key configured in the node credentials.
  • The base URL for the TeleFlow API must be set in the credentials configuration.
  • The node uses HTTP DELETE requests to interact with the API.

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 supply a valid ID.
  • API Connection Issues: Network problems or incorrect API credentials can cause failures. Verify your API key/token and base URL are correct.
  • Resource Not Found: Attempting to delete a non-existent Tariff Profile may result in an error from the API. Confirm the ID corresponds to an existing resource.
  • Permission Denied: Insufficient permissions associated with the API credentials can prevent deletion. Check user roles and API access rights.

Links and References

Discussion