3CX icon

3CX

Interact with 3CX telephony system

Actions462

Overview

This node integrates with the 3CX telephony system, allowing users to interact programmatically with various 3CX services. Specifically, the "Enable" operation under the "Services" resource is designed to enable one or more specified services within the 3CX system. This can be useful in scenarios where automated control over telephony services is needed, such as enabling call recording, voicemail, or other telephony features dynamically based on workflow conditions.

Practical examples include:

  • Automatically enabling specific telephony services when a new user is onboarded.
  • Enabling call forwarding or voicemail services during certain hours or events.
  • Managing service states as part of broader communication automation workflows.

Properties

Name Meaning
Options A JSON object containing an array named ServiceNames which lists the names of services to enable. Example: { "ServiceNames": ["Voicemail", "CallRecording"] }

Output

The node outputs JSON data representing the result of the enable operation. This typically includes confirmation of which services were successfully enabled and any relevant status messages returned by the 3CX API. The exact structure depends on the 3CX API response but generally confirms the action's success or failure.

No binary data output is indicated.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token configured via OAuth2 credentials for secure access.
  • The base URL for the 3CX API must be provided in the node credentials configuration.
  • The node sends requests to the 3CX API endpoint /xapi/v1.

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 taken.
    • Network connectivity problems between n8n and the 3CX server can cause request timeouts or failures.
  • Error messages:

    • Authentication errors usually indicate invalid or expired tokens; re-authenticate or update credentials.
    • "Service not found" errors suggest that one or more service names are incorrect or unavailable in the 3CX system.
    • HTTP errors (e.g., 400, 500) indicate issues with the request or server; verify input data and server health.

Links and References

Discussion