3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, allowing users to manage and interact with various telephony resources programmatically. Specifically, the "Set Routes" operation under the "Trunks" resource enables users to configure routing rules for trunks in their 3CX system. This is useful for administrators who want to automate or dynamically update call routing paths based on business logic or external triggers.

Practical examples include:

  • Automatically updating trunk routes when new call centers are added.
  • Changing routing priorities during off-hours or special events.
  • Integrating with CRM systems to route calls based on customer data.

Properties

Name Meaning
Routes A JSON object defining the routing configuration for trunks. It expects a structure like:
json { "Routes": [ {...} ] }
This property allows specifying multiple route entries to be set for the trunks.

Output

The node outputs JSON data representing the response from the 3CX API after setting the routes. The exact structure depends on the API's response but typically includes confirmation of the updated routes or error details if the operation failed.

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 (referred generically as an API key credential).
  • The base URL for the 3CX server must be provided in the node credentials.
  • The node sends requests to the /xapi/v1 endpoint of the 3CX server.

Troubleshooting

  • Invalid JSON in Routes: If the JSON provided in the Routes property is malformed, the node will fail. Ensure the JSON syntax is correct before execution.
  • Authentication Errors: If the OAuth2 token is missing, expired, or invalid, the node will return authentication errors. Refresh or reconfigure the API credentials.
  • Server URL Issues: An incorrect or unreachable 3CX server URL will cause connection failures. Verify the server URL in the credentials.
  • API Response Errors: If the 3CX API rejects the route configuration (e.g., due to invalid route parameters), the node will output the error message from the API. Review the route definitions for correctness.

Links and References

Discussion