3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically allowing users to create FXS (Foreign Exchange Station) devices within 3CX. FXS devices are used to connect analog telephones or fax machines to a VoIP network. This node is beneficial in scenarios where automated provisioning and management of telephony hardware is required, such as setting up multiple phone lines or configuring telephony infrastructure programmatically.

Practical examples include:

  • Automatically creating and configuring new FXS devices when onboarding new office locations.
  • Bulk provisioning of FXS lines with specific codecs, models, and network settings.
  • Integrating telephony device setup into broader IT automation workflows.

Properties

Name Meaning
Brand The brand name of the FXS device to be created.
Codecs JSON array specifying the audio codecs supported by the FXS device.
Fxs Line Count Number of FXS lines to create.
Fxs Lines JSON array detailing individual FXS line configurations.
Group Group identifier or name to which the FXS device belongs.
Language Language setting for the FXS device.
Mac Address MAC address of the FXS device for identification and provisioning.
Model Model identifier of the FXS device.
Model Name Human-readable model name of the FXS device.
Name Name assigned to the FXS device.
Password Password for authentication or device access.
Provisioning JSON object containing provisioning details and parameters for the FXS device.
Registered JSON object representing registration status or related data for the FXS device.
Secret Secret key or token used for secure communication or authentication.
Template JSON object defining templates including allowed network configurations, languages, models, etc.
Time Zone Time zone setting for the FXS device.
Variables JSON array of variables and their values to customize the FXS device configuration.

Output

The node outputs JSON data representing the result of the FXS creation operation. This typically includes confirmation details about the newly created FXS device(s), such as identifiers, status, and any relevant metadata returned by the 3CX API.

No binary data output is indicated.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • 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 the credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials can cause authentication failures.
    • Incorrectly formatted JSON input for properties like Codecs, FxsLines, Provisioning, Registered, Template, or Variables may lead to parsing errors.
    • Providing invalid MAC addresses or unsupported model names might cause the 3CX API to reject the request.
    • Network connectivity issues between n8n and the 3CX server can prevent successful execution.

  • Error messages:

    • Authentication errors usually indicate problems with the API key or OAuth token; verify credentials and permissions.
    • JSON parsing errors suggest malformed JSON input; ensure all JSON fields are valid and properly escaped.
    • API response errors from 3CX often include status codes and messages; consult 3CX API documentation for specific error meanings.

Links and References

Discussion