TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to manage telephony-related resources. Specifically, for the Number Port resource with the Delete operation, it deletes a number port entry identified by its unique ID. This is useful in scenarios where you need to programmatically remove number porting requests or records from your TeleFlow system.

Practical examples include:

  • Automatically cleaning up number port requests that are no longer needed.
  • Integrating with workflows that manage telephony provisioning and deprovisioning.
  • Removing outdated or erroneous number port entries as part of a larger automation process.

Properties

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

Note: For the Delete operation on Number Port, only the ID property is mandatory and relevant.

Output

The output JSON contains the response from the TeleFlow API after attempting to delete the specified Number Port resource. Typically, this will be an object indicating success or failure of the deletion request. The exact structure depends on the API but generally includes status information or confirmation of deletion.

No binary data output is produced by this operation.

Example output JSON might look like:

{
  "success": true,
  "message": "Number Port deleted successfully"
}

or in case of error:

{
  "error": "Resource not found"
}

Dependencies

  • Requires an active connection to the TeleFlow API.
  • Needs an API authentication token or key configured in n8n credentials (referred generically as "an API key credential").
  • The base URL for the TeleFlow API must be set in the node's credentials configuration.

Troubleshooting

  • Missing ID Error: If the ID property is not provided, the node throws an error stating "ID is required for delete operation". Ensure the ID is correctly set.
  • API Connection Issues: Network errors or invalid credentials will cause HTTP request failures. Verify API keys and network connectivity.
  • Resource Not Found: If the ID does not correspond to an existing Number Port resource, the API may return an error. Confirm the ID is correct.
  • Continue On Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions.

Discussion