3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download queue performance totals reports. It is designed to retrieve detailed performance data for specific call queues within a defined time period. This functionality is useful for contact center managers or administrators who want to analyze call queue metrics such as wait times, call volumes, and agent performance over a selected date range.

Typical use cases include:

  • Generating historical performance reports for call queues.
  • Monitoring queue efficiency and identifying bottlenecks.
  • Exporting queue statistics for further analysis or integration with other reporting tools.

Properties

Name Meaning
Period From The start date/time of the report period. Usage: periodFrom={periodFrom}
Period To The end date/time of the report period. Usage: periodTo={periodTo}
Queue Dns The DNS name of the queue to retrieve performance totals for. Usage: queueDns={queueDns}
Wait Interval The interval for wait time aggregation. Usage: waitInterval={waitInterval}
Options Additional query options to customize the report output:
- Top Show only the first n items
- Skip Skip the first n items
- 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 report for the specified parameters. The structure typically includes aggregated metrics about the queue's activity during the requested period, such as call counts, wait times, and other relevant statistics.

If binary data is included (not explicitly shown in the provided code), it would represent downloadable report files or raw data exports.

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 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 the 3CX system.
  • API rate limits or connectivity issues: Check network connectivity and API usage limits.
  • Incorrect query options: Improperly formatted filter, search, or orderby strings may cause API errors; validate these inputs carefully.

Links and References

Discussion