TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to manage various resources, including devices. Specifically, the "Delete" operation for the "Device" resource allows users to remove a device from their TeleFlow system by specifying its unique identifier. This is useful in scenarios where devices are decommissioned, replaced, or no longer needed, helping keep the system clean and up-to-date.

Practical example: If an organization retires a phone device, this node can be used to delete that device record from TeleFlow automatically as part of a workflow, ensuring inventory accuracy.

Properties

Name Meaning
ID The unique identifier of the device to delete. This is required to specify which device to remove.
Fields Optional field-value pairs to include in the request for more specific queries (not typically used in delete but available).

Output

The output JSON contains the response from the TeleFlow API after attempting to delete the specified device. Typically, this will confirm whether the deletion was successful or provide details if it failed. The structure depends on the API's response but generally includes status information.

No binary data output is produced by this operation.

Example output JSON might look like:

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

or, in case of failure:

{
  "error": "Device not found"
}

Dependencies

  • Requires an active connection to the TeleFlow API.
  • Needs an API authentication token configured in the node credentials.
  • The base URL for the TeleFlow API must be set in the credentials configuration.

Troubleshooting

  • Missing ID error: The node throws an error if the "ID" property is not provided because the API requires the device ID to perform deletion.
  • API errors: If the device does not exist or the user lacks permissions, the API may return errors. These are passed through in the output JSON under an "error" key.
  • Network issues: Connectivity problems to the TeleFlow API endpoint will cause request failures.
  • To resolve errors, verify the device ID is correct, ensure proper API credentials are configured, and check network connectivity.

Links and References

  • TeleFlow API documentation (refer to official TeleFlow API docs for detailed endpoints and responses)
  • n8n HTTP Request node documentation for understanding how requests are made within n8n workflows

Discussion