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 purge outbound rules. Purging outbound rules typically means removing or clearing specific routing or dialing rules that control how calls are handled or routed in the telephony system. This operation is useful for administrators who want to clean up or reset call routing configurations programmatically.

A practical example would be an automated workflow that clears outdated or invalid outbound call rules before applying new configurations, ensuring the telephony system routes calls correctly without manual intervention.

Properties

Name Meaning
Purge Object A JSON object specifying the IDs of the outbound rules to purge. Example format: {"Ids": [id1, id2]} where each ID corresponds to an outbound rule to be removed.

Output

The node outputs JSON data representing the result of the purge operation. This typically includes confirmation of which outbound rules were successfully purged or any errors encountered during the process. The exact structure depends on the 3CX API response but generally confirms the status of the requested purge action.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in the credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1.
  • The request headers specify Accept: application/json.

Troubleshooting

  • Common issues:

    • Invalid or missing IDs in the purge object can cause the API to reject the request.
    • Incorrect or expired API authentication token will lead to authorization errors.
    • Misconfigured server URL (e.g., trailing slash issues) might cause request failures.

  • Error messages and resolutions:

    • Unauthorized / 401 error: Check that the API key credential is valid and has not expired.
    • Bad Request / 400 error: Verify the JSON structure of the purge object; ensure IDs are correctly specified as an array.
    • Not Found / 404 error: Confirm that the specified outbound rule IDs exist in the 3CX system.
    • Network errors: Ensure the 3CX server URL is reachable from the n8n instance.

Links and References

Discussion