3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically providing an operation to perform garbage collection on services within 3CX. Garbage collection typically involves cleaning up unused or obsolete data or resources to optimize system performance and free up space. This operation would be beneficial in scenarios where administrators want to maintain the health and efficiency of their 3CX system by removing unnecessary service data.

Practical examples include:

  • Automatically cleaning up stale call logs or temporary service files.
  • Maintaining optimal performance by periodically running garbage collection tasks via n8n workflows.

Properties

Name Meaning
Options A JSON object specifying parameters for the garbage collection operation. Users input this as a JSON string, which is parsed and sent in the request body.

Output

The node outputs JSON data representing the response from the 3CX API after performing the garbage collection operation. The exact structure depends on the 3CX API's response but generally includes status information about the garbage collection process.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the 3CX system (OAuth2-based).
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure that the OAuth2 API credentials are correctly set up and valid.
  • Invalid JSON in Options: Since the Options property expects a JSON string, malformed JSON will cause parsing errors. Validate JSON syntax before input.
  • API endpoint issues: Verify the 3CX server URL is correct and accessible.
  • Permission issues: The authenticated user must have sufficient rights to perform garbage collection operations.

Links and References

Discussion