3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically providing an operation to delete a fax by its unique identifier. It is useful in scenarios where you need to programmatically manage faxes within 3CX, such as cleaning up old or unwanted fax records automatically. For example, after processing a fax, you might want to delete it to maintain storage hygiene or comply with data retention policies.

Properties

Name Meaning
Id The unique identifier of the fax entity to delete. You can provide this directly or use an expression like {{$json.Id}} to dynamically specify the fax ID.
If Match An optional ETag value used for concurrency control. This header ensures that the fax is deleted only if the current version matches the provided ETag, preventing accidental deletion of updated resources.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will be confirmation of successful deletion or an error message if the deletion failed. There is no binary data output associated with this operation.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the node credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent fax ID will result in an error indicating the resource was not found.
    • Incorrect or missing API credentials will cause authentication failures.
    • Using an outdated or incorrect ETag in the "If Match" property may lead to a conflict error, preventing deletion.

  • Error messages and resolutions:

    • 404 Not Found: Verify that the fax ID exists and is correct.
    • 401 Unauthorized: Check that the API key credential is valid and properly configured.
    • 412 Precondition Failed: The ETag does not match the current resource version; refresh the ETag and try again.

Links and References

Discussion