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 start services within 3CX. It is useful in scenarios where automated control over telephony services is needed, such as initiating call queues, activating specific telephony features, or managing service states programmatically. For example, a user might automate starting certain communication services at the beginning of a workday or trigger service activation based on external events.

Properties

Name Meaning
Options JSON object specifying which services to start. The key ServiceNames accepts an array of service names to be started. Example: { "ServiceNames": ["Service1", "Service2"] }

Output

The node outputs JSON data representing the response from the 3CX API after attempting to start the specified services. This typically includes status information about each requested service start operation. The output does not include binary data.

Dependencies

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

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid or misspelled service names in the ServiceNames array may result in errors or no action.
    • Network connectivity problems to the 3CX server can prevent successful requests.

  • Error messages:

    • Authentication errors typically indicate invalid or expired tokens; re-authenticate or update credentials.
    • API errors related to service names suggest verifying that the service names exist and are correctly spelled.
    • Timeout or connection errors require checking network access and server availability.

Links and References

Discussion