3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, allowing users to interact programmatically with its API. Specifically, the "Defs" resource with the "Get Routes" operation enables retrieval of routing definitions or configurations from the 3CX system. This can be useful for automating call routing management, auditing current route setups, or integrating telephony routing data into other workflows.

Practical examples include:

  • Fetching specific route definitions by their IDs to display or process them in a CRM.
  • Automating checks on route configurations as part of a monitoring workflow.
  • Synchronizing route data between 3CX and other communication platforms.

Properties

Name Meaning
Ids A JSON array containing one or more route IDs to retrieve. The node expects this input as a JSON string which it parses and sends in the request body. Example: [null] or ["routeId1", "routeId2"].

Output

The node outputs JSON data representing the requested route definitions from the 3CX system. The structure typically includes details about each route such as identifiers, destination numbers, conditions, and actions configured in the 3CX telephony system.

If binary data is returned (not indicated here), it would represent associated media or configuration files related to routes, but this node primarily deals with JSON route data.

Dependencies

  • Requires an active connection to a 3CX telephony system via its API.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The base URL for the 3CX server must be provided in the credentials.
  • The node uses HTTP headers specifying JSON content type (Accept: application/json).

Troubleshooting

  • Invalid or missing IDs: If the "Ids" property contains invalid JSON or IDs that do not exist, the API may return errors or empty results. Ensure the JSON is well-formed and IDs are correct.
  • Authentication errors: Missing or incorrect API credentials will cause authorization failures. Verify the API key/token and server URL in the credentials.
  • Network issues: Connectivity problems to the 3CX server will prevent data retrieval. Check network access and server availability.
  • Unexpected response format: If the 3CX API changes or returns unexpected data, the node might fail to parse the output correctly.

Links and References

Discussion