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 configure backup settings. The "Set Backup Settings" operation under the "Backups" resource enables users to define how backups are handled, including encryption and scheduling options. This is useful for administrators who want to automate backup configurations or update backup parameters programmatically within their workflows.

Practical examples include:

  • Automatically setting or updating backup schedules based on business hours.
  • Enabling or disabling encryption for backup files via workflow triggers.
  • Integrating backup configuration changes as part of a larger system maintenance automation.

Properties

Name Meaning
Settings JSON object defining backup settings. It includes options such as:
- Contents: e.g., EncryptBackupPassword to specify if the backup should be encrypted.
- Schedule: configuration details for when backups should run.

The property expects a JSON string that will be parsed and sent as the request body.

Output

The node outputs data in JSON format representing the response from the 3CX API after setting the backup settings. This typically includes confirmation of the updated settings or any error messages returned by the API.

No binary data output is indicated.

Dependencies

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

Troubleshooting

  • Invalid JSON in Settings: If the JSON provided in the "Settings" property is malformed, the node will fail to parse it. Ensure valid JSON syntax.
  • Authentication Errors: Missing or incorrect API credentials will cause authorization failures. Verify the OAuth2 token and server URL.
  • API Endpoint Issues: Incorrect server URL or network issues can prevent communication with the 3CX API.
  • Unsupported Settings Format: The structure of the JSON must conform to what the 3CX API expects for backup settings; otherwise, the API may reject the request.

Links and References

Discussion