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 remove outdated or incorrect number porting requests from your system.

Practical examples include:

  • Automatically cleaning up number port requests that are no longer needed.
  • Integrating with workflows that manage telephony provisioning and de-provisioning.
  • Removing erroneous or duplicate number port entries as part of a data maintenance 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).

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 operation. No binary data is output by this node.

Example output structure:

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

or, in case of error:

{
  "error": "Error message describing what went wrong"
}

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 methods (DELETE) to communicate with the TeleFlow REST API.

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 Authentication Errors: If the API key or base URL is incorrect or missing, the node will fail to authenticate. Verify credentials configuration.
  • Resource Not Found: If the ID does not correspond to an existing Number Port resource, the API may return a 404 error. Confirm the ID is valid.
  • Network Issues: Connectivity problems can cause request failures. Check network access to the TeleFlow API endpoint.
  • Continue on Fail: If enabled, errors will be returned as part of the output JSON instead of stopping execution.

Links and References

Discussion