3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing functionality to list queues within the system. It is useful for scenarios where users need to retrieve and manage call queues, such as monitoring queue status, analyzing call distribution, or integrating queue data into workflows.

For example, a user might use this node to fetch all active call queues to display their statuses on a dashboard or to automate reporting on queue performance.

Properties

Name Meaning
Options A collection of optional query parameters to customize the list of queues returned:
- Top ($top) Limits the number of items returned to the first n items.
- Skip ($skip) Skips the first n items in the result set.
- Search ($search) Searches items by search phrases; supports phrase searching with quotes if needed.
- Filter ($filter) Filters items based on property values (e.g., State eq 'Connected').
- Count ($count) Includes the count of items in the response when set to true.
- Orderby ($orderby) Orders items by specified property values (e.g., Name desc, CreatedAt asc).
- Select ($select) Selects specific properties to be returned (e.g., Id,Name).
- Expand ($expand) Expands related entities to include additional linked data.

Output

The node outputs JSON data representing the list of queues retrieved from the 3CX system. Each item in the output corresponds to a queue object containing its properties as requested via the $select option or default properties otherwise.

If binary data were involved (not indicated here), it would typically represent media or files related to the queues, but this node focuses on JSON queue data only.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the node credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token provided in credentials is valid and has sufficient permissions.
  • Invalid query parameters: Incorrect syntax in filter, orderby, or other options may cause API errors. Validate OData query expressions.
  • Empty results: If no queues are returned, verify that the 3CX system actually has queues matching the criteria or that the search/filter parameters are correct.
  • Network issues: Check connectivity to the 3CX server URL and ensure it is reachable from n8n.

Links and References

Discussion