3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download a performance overview report of a specific queue within a given time period. It is useful for monitoring and analyzing call queue metrics such as wait times, call volumes, and agent performance in contact center environments using 3CX.

Typical use cases include:

  • Generating historical reports on queue performance for management review.
  • Automating data extraction for further analysis or dashboarding.
  • Monitoring queue health and identifying bottlenecks or service issues.

For example, a user can specify a date range and a particular queue DNS name to retrieve detailed performance data, which can then be used to optimize staffing or improve customer experience.

Properties

Name Meaning
Period From Start date/time of the reporting period (format expected by the API).
Period To End date/time of the reporting period (format expected by the API).
Queue Dns The DNS identifier of the queue for which the performance overview is requested.
Wait Interval The interval duration for wait time aggregation or sampling.
Options Additional query options to customize the request:
- Top Show only the first n items.
- Skip Skip the first n items.
- Search Search items by search phrases (supports quoted 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 (comma-separated list).
- Orderby Order items by property values (e.g., "Name desc, CreatedAt asc").
- Expand Expand related entities (comma-separated list).

Output

The node outputs JSON data representing the queue performance overview report retrieved from the 3CX API. This typically includes metrics aggregated over the specified period and queue, such as call counts, average wait times, and other relevant statistics.

If binary data were involved (e.g., file downloads), it would be summarized here, but based on the provided code and properties, the output is JSON structured data.

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 uses the 3CX REST API endpoint /xapi/v1 to fetch data.
  • Proper network access to the 3CX server is necessary.

Troubleshooting

  • Invalid Date Format: Ensure that "Period From" and "Period To" are in the correct format expected by the 3CX API; otherwise, the request may fail.
  • Authentication Errors: Verify that the API key credential is valid and has sufficient permissions.
  • Queue DNS Not Found: Confirm that the "Queue Dns" value matches an existing queue in the 3CX system.
  • API Rate Limits or Timeouts: Large queries or improper pagination (Top/Skip) might cause timeouts; adjust options accordingly.
  • Incorrect Query Options: Misuse of filter, search, or orderby syntax can lead to errors; refer to 3CX API documentation for correct usage.

Links and References

Discussion