3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve queue performance totals data for a specified period and queue. It is useful for monitoring and reporting on call center or telephony queue metrics, helping administrators analyze queue performance over time.

Typical use cases include:

  • Generating reports on call queue activity between two dates.
  • Monitoring queue performance metrics such as wait times or call counts.
  • Filtering and sorting queue data to focus on specific criteria or top-performing queues.

For example, you might use this node to get the total number of calls handled by a particular queue during the last week or to find the top 10 busiest queues in a given timeframe.

Properties

Name Meaning
Period From The start date/time of the period for which to retrieve queue performance data.
Period To The end date/time of the period for which to retrieve queue performance data.
Queue Dns The DNS name of the queue to query performance totals for.
Wait Interval The interval used to calculate wait times or related metrics within the queue performance data.
Options Additional query options to refine the data retrieval:
- Top Show only the first n items (limit results).
- Skip Skip the first n items (offset results).
- Search Search items by search phrases.
- Filter Filter items by property values (e.g., "State eq 'Connected'").
- Count Include count of items (boolean).
- Select Select specific properties to be returned (e.g., "Id,Name").
- Orderby Order items by property values (e.g., "Name desc, CreatedAt asc").
- Expand Expand related entities (e.g., "RelatedEntity1,RelatedEntity2").

Output

The node outputs JSON data containing the queue performance totals matching the specified parameters and filters. This typically includes aggregated metrics about queue activity such as call counts, wait times, and other performance indicators.

If binary data were supported, it would represent downloadable reports or files, but based on the provided code and properties, output is JSON structured data only.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1 with appropriate headers.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API authentication token or OAuth2 credentials are correctly set up in n8n.
  • Invalid date formats: The Period From and Period To fields must be valid date/time strings accepted by the 3CX API.
  • Queue DNS not found: Verify that the Queue Dns value corresponds to an existing queue in your 3CX system.
  • API errors due to filtering or query options: Incorrect syntax in $filter, $orderby, or other OData-like query options may cause errors. Validate these expressions against 3CX API documentation.
  • Empty results: Check if the specified period actually contains data; adjust the date range or filters accordingly.

Links and References

Discussion