3CX icon

3CX

Interact with 3CX telephony system

Actions462

Overview

This node integrates with the 3CX telephony system, allowing users to interact programmatically with its services. Specifically, the "Disable" operation under the "Services" resource lets users disable one or more specified services within the 3CX system. This can be useful for automating administrative tasks such as temporarily suspending certain telephony services without manual intervention.

Practical examples include:

  • Automatically disabling specific call routing services during off-hours.
  • Temporarily suspending voicemail or conferencing services based on business rules.
  • Managing service availability dynamically in response to external triggers.

Properties

Name Meaning
Options JSON object containing an array named ServiceNames specifying which services to disable. Example: { "ServiceNames": ["Service1", "Service2"] }

Output

The node outputs a JSON object representing the response from the 3CX API after attempting to disable the specified services. The exact structure depends on the API's response but typically includes status information about the success or failure of the disable operation for each service.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node expects a base URL for the 3CX server, configured via credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1.
  • Proper OAuth2 authentication setup is necessary to authorize API calls.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect service names in the ServiceNames array may result in errors or no action.
    • Network connectivity problems to the 3CX server will prevent successful API calls.
  • Error messages and resolutions:

    • Authentication errors: Verify that the API key or OAuth2 token is correctly configured and has not expired.
    • Service not found: Check that the service names provided exactly match those configured in the 3CX system.
    • Request failures: Ensure the 3CX server URL is correct and accessible from the n8n environment.

Links and References

Discussion