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 Template. Deleting a Trunk Template is useful when you want to remove an existing configuration template for trunks in your 3CX system, such as when cleaning up unused or outdated templates.

A practical example would be automating the cleanup of trunk templates that are no longer needed after a migration or reconfiguration, ensuring your telephony setup remains organized and efficient.

Properties

Name Meaning
Id The unique identifier of the Trunk Template to delete. Can be set using expressions like {{$json.Id}}. This property is required.
If Match Optional ETag header value used for concurrency control. It ensures the template is deleted only if it matches the specified version.

Output

The node outputs JSON data representing the response from the 3CX API after attempting to delete the Trunk Template. 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 authentication token credential configured for 3CX OAuth2.
  • Needs the base URL of the 3CX server to be set in the credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Providing an incorrect or missing Id will cause the deletion to fail.
    • Using an invalid or stale If Match ETag may result in a concurrency error, preventing deletion.
    • Network connectivity or authentication failures can block communication with the 3CX API.

  • Error messages:

    • 404 Not Found: The specified Trunk Template ID does not exist.
    • 412 Precondition Failed: The ETag provided in If Match does not match the current resource version.
    • 401 Unauthorized: Authentication failed due to invalid or missing credentials.

  • Resolutions:

    • Verify the Id corresponds to an existing Trunk Template.
    • Use the correct and current ETag value if using the If Match header.
    • Ensure valid API credentials and network access to the 3CX server.

Links and References

Discussion