3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing an operation to stop services within 3CX. It is useful in scenarios where you need to programmatically control telephony services, such as stopping specific call handling services or other related components managed by 3CX. For example, an administrator might use this node to halt certain services during maintenance windows or to reset service states automatically.

Properties

Name Meaning
Options JSON object containing a list of service names to stop. The key ServiceNames expects an array of strings representing the names of the services to be stopped. Example: { "ServiceNames": ["Service1", "Service2"] }

Output

The node outputs JSON data representing the response from the 3CX API after attempting to stop the specified services. This typically includes status information about each service requested to be stopped, such as success or failure messages. There is no indication that the node outputs binary data.

Dependencies

  • Requires an API authentication token credential for 3CX OAuth2.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Incorrect or missing service names in the ServiceNames array may cause the API to return errors or fail to stop any services.
    • Invalid or expired API authentication tokens will result in authorization errors.
    • Misconfigured server URL (e.g., missing protocol or trailing slash) can lead to connection failures.

  • Error messages and resolutions:

    • Unauthorized / 401 errors: Check that the API authentication token is valid and has not expired.
    • 404 Not Found: Verify that the service names provided exist on the 3CX server.
    • Connection errors: Ensure the server URL is correct and reachable from the n8n instance.

Links and References

Discussion