TeleFlow icon

TeleFlow

Interact with TeleFlow API

Actions82

Overview

This node integrates with the TeleFlow API to manage various telephony-related resources. Specifically, for the Phone Number - Delete operation, it allows users to delete a phone number resource by specifying its unique identifier. This is useful in scenarios where phone numbers need to be removed from the system, such as decommissioning unused numbers or cleaning up test data.

Practical example: A user wants to automate the removal of phone numbers that are no longer active or required in their telephony system. By providing the phone number's ID, this node will send a delete request to the TeleFlow API to remove it.

Properties

Name Meaning
ID The unique identifier of the phone number resource to delete. This is a required string.
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 phone number. Typically, this will confirm whether the deletion was successful or provide details if an error occurred.

No binary data output is produced by this operation.

Example output structure:

{
  "success": true,
  "message": "Phone number deleted successfully"
}

or in case of failure:

{
  "error": "Resource not found"
}

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 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 phone number ID.
  • API Errors: If the API returns an error (e.g., resource not found, permission denied), the node will either throw an error or return it in the output JSON if "Continue On Fail" is enabled.
  • Network Issues: Connectivity problems or incorrect base URL configuration can cause request failures. Verify network access and credential settings.
  • Permission Issues: Ensure the API key has sufficient permissions to delete phone number resources.

Links and References

Discussion