3CX icon

3CX

Interact with 3CX telephony system

Actions462

Overview

This node integrates with the 3CX telephony system, specifically allowing users to delete an FXS (Foreign Exchange Station) device identified by its MAC address. It is useful in scenarios where telephony hardware needs to be programmatically removed from the system, such as during device decommissioning or replacement workflows.

For example, a user might automate the removal of an FXS device after it has been physically disconnected or replaced, ensuring the telephony system's configuration stays up to date without manual intervention.

Properties

Name Meaning
Mac Address The MAC address key identifying the FXS device to delete. Supports expressions, e.g., {{$json.MacAddress}}. This is a required field.
If Match Optional ETag header value used for concurrency control. It ensures the delete operation only proceeds if the resource matches this ETag.

Output

The node outputs JSON data representing the response from the 3CX API after attempting to delete the specified FXS device. Typically, this will include status information confirming whether the deletion was successful.

No binary data output is expected from this operation.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token configured via OAuth2 credentials to authorize requests.
  • The base URL for the 3CX API must be set in the node credentials.

Troubleshooting

  • Common issues:

    • Incorrect or missing MAC address will cause the delete operation to fail.
    • Providing an invalid or outdated ETag in the "If Match" property may result in a concurrency error.
    • Network connectivity problems or incorrect API base URL can prevent communication with the 3CX server.
  • Error messages:

    • 404 Not Found: The specified MAC address does not correspond to any existing FXS device.
    • 412 Precondition Failed: The ETag provided in "If Match" does not match the current resource state.
    • 401 Unauthorized: Authentication failed due to invalid or missing API credentials.

To resolve these errors, verify the MAC address, update the ETag if using concurrency control, and ensure valid API credentials and network access.

Links and References

Discussion