3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically allowing users to delete a user entity within 3CX. It is useful in scenarios where you need to programmatically manage user accounts in your telephony system, such as automating user lifecycle management or cleaning up inactive users.

For example, you might use this node in a workflow that removes users who have left an organization by specifying their unique user ID.

Properties

Name Meaning
Id The unique identifier of the user entity to delete. You can provide this directly or via an expression like {{$json.Id}}. This property is required.
If Match An optional ETag value used for concurrency control. It is sent as the If-Match HTTP header to ensure the user is deleted only if the resource matches this ETag.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will be confirmation of successful deletion or details about any error encountered. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the 3CX system.
  • The node uses the base URL configured in the credentials, which should point to the 3CX server's API endpoint.
  • The node sends requests with an Accept: application/json header and expects JSON responses.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent user ID will likely result in an error response from the 3CX API.
    • Omitting the required Id property will prevent the node from executing properly.
    • Incorrect or missing API authentication credentials will cause authorization failures.
    • Using an incorrect or stale ETag in the If Match property may lead to a precondition failure error.

  • Error messages:

    • Authorization errors indicate problems with the API key or token; verify credentials are correctly set.
    • "User not found" or similar errors suggest the specified user ID does not exist.
    • Precondition failed errors related to If Match mean the ETag does not match the current resource state; try omitting this header or updating it.

Links and References

Discussion