3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node operation updates the settings of a fax server within the 3CX telephony system. It allows users to modify various configuration parameters such as authentication credentials, email, fax number, and other operational flags related to fax handling. This is useful in scenarios where an administrator needs to programmatically adjust fax server configurations without manually accessing the 3CX management console.

Practical examples include:

  • Automating updates to fax server credentials or contact information.
  • Enabling or disabling remote storage for faxes based on changing policies.
  • Adjusting cleanup and fallback behaviors dynamically according to system load or maintenance schedules.

Properties

Name Meaning
Auth Id The authentication identifier used by the fax server for secure access.
Auth Password The password associated with the Auth Id, provided as JSON to support complex structures.
Auto Cleanup Boolean flag indicating whether automatic cleanup of fax data is enabled.
Email Contact email address associated with the fax server.
Fax Server Id Numeric identifier of the fax server to update.
G 711 To T 38 Fallback Boolean flag to enable fallback from G.711 codec to T.38 protocol for fax transmission.
Max Age Maximum age (in unspecified units) for certain fax server data or settings.
Number The fax number assigned to the fax server.
Remote Storage Enabled Boolean flag indicating if remote storage for faxes is enabled.

Output

The node outputs JSON data representing the updated fax server settings after the operation completes. This typically includes confirmation of the new configuration values or status messages from the 3CX API. There is no indication that binary data is output by this node.

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 sends requests to the 3CX REST API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure the API key and server URL are correctly configured and valid.
  • Invalid property values: Verify that numeric fields like Fax Server Id and Max Age are numbers and within acceptable ranges.
  • JSON parsing issues: The Auth Password must be valid JSON; malformed JSON will cause errors.
  • Network connectivity: Confirm that the n8n instance can reach the 3CX server URL.
  • API permission errors: The API key must have sufficient permissions to update fax server settings.

Links and References

Discussion