3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically providing functionality to list Call Flow Apps. It allows users to retrieve a collection of call flow applications configured in their 3CX environment. This is useful for scenarios where you want to automate workflows based on existing call flows, audit or monitor call flow configurations, or integrate call flow data into other systems.

For example, a user might use this node to fetch all call flow apps and then filter or process them to generate reports, trigger notifications, or synchronize with a CRM system.

Properties

Name Meaning
Options A collection of optional query parameters to customize the list retrieval:
$top Show only the first n items
$skip Skip the first n items
$search Search items by search phrases. If the search phrase contains spaces and is not quoted, it will be automatically quoted.
$filter Filter items by property values (e.g., State eq 'Connected')
$count Include count of items (boolean)
$orderby Order items by property values (e.g., Name desc, CreatedAt asc)
$select Select specific properties to be returned (e.g., Id,Name)
$expand Expand related entities (e.g., RelatedEntity1,RelatedEntity2)

These options correspond to OData-style query parameters that allow fine-grained control over the data returned from the 3CX API.

Output

The node outputs JSON data representing the list of Call Flow Apps retrieved from the 3CX system. The structure typically includes an array of call flow app objects, each containing properties such as identifiers, names, states, and possibly related entities if expanded.

If binary data were involved (not indicated here), it would represent files or media associated with call flows, but this node focuses on JSON metadata.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The base URL for the 3CX API must be provided in the credentials configuration.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure the API key or OAuth2 token is valid and has sufficient permissions.
  • Invalid query parameters: Incorrect syntax in $filter, $orderby, or other options may cause API errors. Validate these parameters against 3CX API documentation.
  • Empty results: Check if filters or search terms are too restrictive.
  • Network issues: Verify connectivity to the 3CX server URL and that the URL is correctly set without trailing slashes.

Links and References

Discussion