3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically focusing on managing backup restore settings. The "Set Restore Settings" operation under the "Backups" resource allows users to configure how backups are restored in the 3CX system. This can include setting encryption passwords for backups and scheduling restore operations.

Practical scenarios where this node is beneficial include automating backup restoration processes, ensuring backups are encrypted with a password during restore, or scheduling restores at specific times without manual intervention.

Properties

Name Meaning
Settings A JSON object containing restore settings. It supports configuring options such as:
- EncryptBackupPassword: Password used to encrypt the backup during restore.
- Schedule: Scheduling details for when the restore should occur.

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

Output

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

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node uses the base URL configured via credentials, which must point to the 3CX server's API endpoint.
  • The node sends requests with Accept: application/json header and expects JSON responses.

Troubleshooting

  • Invalid JSON in Settings: If the JSON provided in the "Settings" property is malformed, the node will fail to parse it. Ensure the JSON is valid.
  • Authentication Errors: If the API key or authentication token is missing or invalid, the node will return authorization errors. Verify credentials are correctly set up.
  • Server URL Issues: The base URL must be correctly configured without trailing slashes; otherwise, requests may fail.
  • API Errors: Any errors returned by the 3CX API (e.g., invalid parameters) will be passed through. Check the API documentation for correct parameter usage.

Links and References

Discussion