3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically allowing users to delete a tenant property by its key (Name). It is useful in scenarios where you need to programmatically remove configuration or metadata entries associated with tenants in 3CX. For example, if a tenant property is no longer needed or must be reset, this operation can automate that cleanup.

Properties

Name Meaning
Name The key of the tenant property to delete. Supports expressions, e.g., {{$json.Name}}.
If Match The ETag value for concurrency control. Used as an HTTP header to ensure the property is deleted only if it matches the specified version.

Output

The output JSON will typically contain the response from the 3CX API after attempting to delete the tenant property. Since this is a delete operation, the output may be empty or contain status information confirming the deletion. No binary data output is expected.

Dependencies

  • Requires an API authentication token credential for 3CX OAuth2.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Deletion fails if the "Name" property does not match any existing tenant property.
    • If the "If Match" ETag header is incorrect or missing when required, the API may reject the request due to concurrency conflicts.
    • Network or authentication errors if the API token or server URL is misconfigured.

  • Error messages:

    • 404 Not Found: The specified tenant property name does not exist.
    • 412 Precondition Failed: The ETag provided in "If Match" does not match the current version of the property.
    • 401 Unauthorized: Invalid or missing API authentication token.

To resolve these:

  • Verify the tenant property key is correct.
  • Use the latest ETag value for the "If Match" header if concurrency control is enabled.
  • Check API credentials and server URL configuration.

Links and References

  • 3CX API documentation (refer to tenant properties management section)
  • n8n documentation on using OAuth2 credentials and HTTP headers

Discussion