3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically providing functionality to purge chat data based on specified settings. The "Purge Chats" operation under the "Purge Settings" resource allows users to delete chat records within a defined period. This is useful for maintaining data hygiene, complying with data retention policies, or freeing up storage by removing old or unnecessary chat logs.

Practical examples include:

  • Automatically deleting chat messages older than a certain date.
  • Clearing chat history periodically to comply with company privacy rules.
  • Managing storage limits by purging chats in bulk.

Properties

Name Meaning
Period A JSON object defining the time period for which chats should be purged. This typically includes date ranges or relative time frames specifying which chat records to delete.

Output

The node outputs JSON data representing the result of the purge operation. This output likely contains information such as the number of chats deleted, status messages, or any errors encountered during the purge process.

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 uses HTTP requests to interact with the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid JSON format in the "Period" property may lead to request errors.
    • Network connectivity problems to the 3CX server can prevent successful API calls.

  • Error messages and resolutions:

    • Authentication failed: Verify that the API key and server URL are correctly set in the credentials.
    • Invalid period format: Ensure the "Period" input is valid JSON and matches the expected structure required by the 3CX API.
    • Request timeout or connection error: Check network access to the 3CX server and firewall settings.

Links and References

Discussion