3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node integrates with the 3CX telephony system, specifically allowing users to update FXS (Foreign Exchange Station) device configurations. This operation is useful for managing and modifying settings of physical or virtual FXS devices registered in a 3CX environment, such as updating device credentials, codecs, line counts, and provisioning details.

Common scenarios include:

  • Updating the configuration of an existing FXS device after hardware replacement or firmware upgrade.
  • Changing authentication credentials or network settings for security or compliance.
  • Modifying codec preferences to optimize call quality or bandwidth usage.
  • Adjusting line count or line-specific settings on multi-line FXS devices.

Practical example: A user wants to update the MAC address and provisioning parameters of an FXS device remotely via n8n workflow, ensuring the device uses new SIP credentials and updated codec settings without manual intervention on the 3CX management console.

Properties

Name Meaning
Mac Address The unique MAC address identifier of the FXS device to update. Supports expressions.
Brand Brand name of the FXS device.
Codecs JSON array specifying preferred audio codecs for the device.
Fxs Line Count Number of FXS lines configured on the device.
Fxs Lines JSON array describing individual FXS line configurations.
Group Group name or identifier to which the device belongs.
Language Language setting for the device interface or prompts.
Model Model identifier of the FXS device.
Model Name Human-readable model name of the device.
Name Friendly name assigned to the FXS device.
Password Password credential for device authentication.
Provisioning JSON object containing provisioning parameters for automatic device setup.
Registered JSON object representing registration status or related info.
Secret Secret key used for authentication or encryption.
Template JSON object defining templates including allowed network configs, languages, models, time zones, and variables.
Time Zone Time zone setting for the device.
Variables JSON array of custom variables or parameters associated with the device.

Output

The node outputs JSON data representing the updated state or response from the 3CX API regarding the FXS device update operation. This typically includes confirmation of changes, updated device details, or error information if the update failed.

No binary data output is indicated.

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or missing MAC address will cause the update to fail since it identifies the target device.
    • Malformed JSON in properties like Codecs, FxsLines, Provisioning, or Variables can lead to parsing errors.
    • Authentication failures due to incorrect or expired API tokens.
    • Network connectivity problems to the 3CX server.

  • Error messages:

    • "Device not found" indicates the MAC address does not match any registered FXS device.
    • "Unauthorized" or "Authentication failed" suggests invalid credentials.
    • "Invalid JSON format" points to syntax errors in JSON input fields.

  • Resolutions:

    • Verify MAC address correctness and existence in 3CX.
    • Ensure all JSON inputs are valid and properly formatted.
    • Check and refresh API credentials.
    • Confirm network access to the 3CX server URL.

Links and References

Discussion