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 trunk resource. Deleting a trunk is useful when you want to remove an existing telephony trunk configuration from your 3CX system, for example, when a trunk is no longer in use or needs to be replaced.

A practical scenario would be automating cleanup of unused trunks based on certain criteria or integrating with other systems to manage telephony resources dynamically.

Properties

Name Meaning
Id The unique identifier of the trunk entity to delete. Can be set using expressions like {{$json.Id}}. This is a required numeric field.
If Match Optional ETag header value used for concurrency control. It ensures that the trunk is deleted only if the ETag matches the current version on the server.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will include confirmation of deletion or any relevant status information returned by the 3CX API.

If the node supports binary data output, it would generally relate to raw HTTP response content, but based on the provided code and properties, the primary output is JSON confirming the deletion.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token configured via OAuth2 credentials (referred generically as "an API key credential").
  • The base URL for the 3CX API must be configured in the node credentials.
  • The node sends requests to the /xapi/v1 endpoint of the 3CX server.

Troubleshooting

  • Common issues:

    • Providing an incorrect or non-existent trunk Id will result in failure to delete.
    • Missing or invalid ETag (If-Match) header may cause the request to fail due to concurrency conflicts.
    • Network connectivity or authentication errors if the API credentials are not properly configured.

  • Error messages:

    • 404 Not Found: The specified trunk Id does not exist.
    • 412 Precondition Failed: The ETag provided in If-Match does not match the current version of the trunk, indicating it has been modified since last retrieval.
    • 401 Unauthorized: Authentication failed; check API credentials.

  • Resolutions:

    • Verify the trunk Id is correct and exists.
    • Use the latest ETag value retrieved from the trunk resource before attempting deletion.
    • Ensure API credentials are valid and have necessary permissions.

Links and References

Discussion