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 restart services within 3CX. It is useful in scenarios where administrators need to programmatically control or refresh specific telephony services without manual intervention on the 3CX server interface. For example, after configuration changes or troubleshooting, restarting certain services can help apply updates or resolve issues.

Properties

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

Output

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

Dependencies

  • Requires an API key credential for authenticating with the 3CX system.
  • Needs the base URL of the 3CX server configured in 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:
    • Incorrect or missing service names in the ServiceNames array may cause the restart operation to fail or have no effect.
    • Invalid or expired API credentials will result in authentication errors.
    • Network connectivity issues to the 3CX server can prevent the node from reaching the API.
  • Error Messages:
    • Authentication failures usually indicate problems with the provided API token or OAuth2 setup; verify and refresh credentials as needed.
    • API errors related to service names suggest checking that the specified services exist and are spelled correctly.
    • Timeout or connection errors imply network or server availability problems; ensure the 3CX server is reachable.

Links and References

Discussion