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 Service Principal entity within 3CX. Deleting a Service Principal is useful for managing access and permissions by removing obsolete or unauthorized service principals from the system.

A practical example would be automating cleanup of service principals that are no longer needed after a project ends or when rotating credentials for security purposes.

Properties

Name Meaning
Id The unique identifier (Entity ID) of the Service Principal to delete. Can be set via expression like {{$json.Id}}. This property is required.
If Match Optional ETag header value used for concurrency control. It ensures the delete operation only proceeds if the resource has not changed since last retrieval.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will confirm whether the deletion was successful or provide error details if it failed.

No binary data output is expected from 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 HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Providing an incorrect or non-existent Service Principal Id will cause the delete operation to fail.
    • Missing or invalid API authentication credentials will prevent the node from connecting to the 3CX API.
    • Using an outdated or incorrect ETag value in the "If Match" header may cause the delete request to be rejected due to concurrency conflicts.

  • Error messages:

    • 404 Not Found: The specified Service Principal Id does not exist.
    • 401 Unauthorized: Authentication failed; check API credentials.
    • 412 Precondition Failed: The ETag provided in "If Match" does not match the current resource state.

To resolve these errors, verify the Id is correct, ensure valid API credentials are configured, and update the ETag value if using concurrency control.

Links and References

  • 3CX API documentation (refer to official 3CX developer resources for detailed API usage)
  • n8n documentation on creating and configuring HTTP request nodes and handling API authentication

Discussion