3CX icon

3CX

Interact with 3CX telephony system

Actions462

Overview

This node interacts with the 3CX telephony system, specifically allowing users to delete a parameter entity within 3CX. It is useful in scenarios where you need to programmatically remove configuration parameters or settings identified by their unique ID from the 3CX system. For example, if an administrator wants to clean up obsolete or incorrect parameters without manually accessing the 3CX management console, this node can automate that process.

Properties

Name Meaning
Id The unique identifier of the parameter entity to delete. Can be set using expressions.
If Match Optional ETag header value for concurrency control, ensuring the parameter is deleted only if it matches the specified version.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will include confirmation of deletion or any error messages returned by the 3CX API. There is no indication that binary data is output by this node.

Dependencies

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

Troubleshooting

  • Common issues:
    • Providing an invalid or non-existent Id will likely cause the API to return an error indicating the parameter was not found.
    • Incorrect or missing API credentials will result in authentication errors.
    • Using an outdated or incorrect If-Match ETag value may cause the delete operation to fail due to concurrency conflicts.
  • Error messages:
    • "Unauthorized" or "Authentication failed": Check API credentials and permissions.
    • "Parameter not found": Verify the Id is correct and exists.
    • "Precondition Failed" (HTTP 412): The If-Match ETag does not match the current resource version; update the ETag or omit it if concurrency control is not needed.

Links and References

Discussion