3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node provides an operation to update Call Detail Record (CDR) settings in a 3CX telephony system. It allows users to configure how call logs are handled, including enabling or disabling CDR logging, selecting which fields to enable, setting log size limits, choosing the log type, and configuring socket connection details for real-time logging.

This node is beneficial in scenarios where administrators want to customize the behavior of call logging in their 3CX system, such as enabling detailed call records for monitoring, compliance, or troubleshooting purposes. For example, an admin might use this node to switch from logging all calls into a single file to creating separate files per call, or to enable socket-based logging to stream call data to an external system.

Properties

Name Meaning
Enabled Boolean flag to enable or disable CDR logging.
Enabled Fields JSON array specifying which CDR fields should be enabled for logging.
Log Size Numeric value defining the maximum size of the log file(s).
Log Type Option to select the logging method:
- Single File For All Calls
- Single File For Each Call
- Passive Socket
- Active Socket
Possible Fields JSON array listing possible CDR fields that can be enabled or disabled.
Remove Comma Delimiters Boolean flag indicating whether to remove comma delimiters from the log entries.
Socket Ip Address String specifying the IP address for socket connections when using socket-based logging.
Socket Port Number specifying the port for socket connections when using socket-based logging.

Output

The node outputs JSON data reflecting the updated CDR settings after the operation completes. This typically includes confirmation of the new configuration state as returned by the 3CX API.

There is no indication that the node outputs binary data.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token or OAuth2 credential configured in n8n to authorize requests to the 3CX API.
  • The base URL for the 3CX server must be provided in the credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 to perform updates.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid JSON format in EnabledFields or PossibleFields properties may cause parsing errors.
    • Providing invalid IP addresses or ports for socket settings could result in connection errors.
    • Setting incompatible combinations of LogType and socket parameters may lead to unexpected behavior.

  • Error Messages:

    • Authentication errors usually indicate invalid or expired credentials; reconfigure the API key or OAuth token.
    • JSON parsing errors suggest malformed JSON input; ensure proper formatting.
    • Network errors related to socket connections imply incorrect IP/port or network restrictions; verify connectivity and firewall settings.

Links and References

Discussion