3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node provides an operation to update remote archiving settings in the 3CX telephony system. This operation allows users to configure how different types of data—such as backups, chats, faxes, recordings, and voicemails—are archived remotely. It also supports specifying detailed location settings including FTP, SFTP, and other password or key configurations.

This node is beneficial in scenarios where organizations want to automate or programmatically manage their telephony system's remote archiving preferences, ensuring that critical communication data is securely stored offsite according to customized parameters.

Practical examples include:

  • Updating backup archiving settings to a new FTP server.
  • Changing chat or voicemail archiving locations with updated credentials.
  • Configuring secure SFTP private keys for remote storage access.

Properties

Name Meaning
Backups JSON object defining remote archiving settings related to backups.
Chats JSON object defining remote archiving settings related to chat messages.
Faxes JSON object defining remote archiving settings related to fax transmissions.
Id Numeric identifier for the specific remote archiving settings record to update.
Location JSON object containing detailed location configuration such as FTP/SFTP passwords and keys.
Recordings JSON object defining remote archiving settings related to call recordings.
Voicemails JSON object defining remote archiving settings related to voicemail messages.

Each JSON property (Backups, Chats, Faxes, Location, Recordings, Voicemails) expects a JSON string input which is parsed before sending in the request body.

Output

The node outputs the response from the 3CX API after attempting to update the remote archiving settings. The output is structured as JSON data representing the updated settings or any status/error information returned by the API.

If the node handles binary data, it would typically relate to files or keys involved in the archiving process, but based on the provided code and properties, the output focuses on JSON responses only.

Dependencies

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

Troubleshooting

  • Invalid JSON Input: Since many properties expect JSON strings that are parsed, invalid JSON formatting will cause errors. Ensure all JSON inputs are correctly formatted.
  • Authentication Errors: If the API token or server URL is incorrect or expired, the node will fail to authenticate. Verify credentials and refresh tokens if necessary.
  • Missing or Incorrect Id: The Id property must correspond to an existing remote archiving settings record. Using an invalid or zero ID may result in errors or no changes applied.
  • API Endpoint Issues: Network issues or incorrect base URLs can cause request failures. Confirm the 3CX server URL is reachable and correct.
  • Permission Denied: The authenticated user must have permissions to update remote archiving settings; otherwise, the API will reject the request.

Links and References

This summary is based solely on static analysis of the provided source code and property definitions.

Discussion