3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download team queue general statistics reports. It is useful for users who want to retrieve detailed performance data about call queues within their teams over a specified time range. Typical scenarios include monitoring call center efficiency, analyzing queue wait times, and generating reports for management review.

For example, a call center manager could use this node to download statistics on how long callers waited in a specific queue during business hours on a given day, helping identify bottlenecks or staffing needs.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue for which statistics are requested.
Start Dt The start date/time for the report period (e.g., "2024-01-01T00:00:00Z").
End Dt The end date/time for the report period (e.g., "2024-01-01T23:59:59Z").
Wait Interval The interval used to calculate wait times in the report (format depends on API requirements).
Options Additional query options to customize the request:
- Top Limit the number of items returned to the first n entries.
- Skip Skip the first n items in the result set.
- Search Search phrase(s) to filter items by text matching.
- Filter OData-style filter expression to restrict results by property values (e.g., State eq 'Connected').
- Count Boolean flag to include the total count of items in the response.
- Select Comma-separated list of properties to return (e.g., Id,Name).
- Orderby Comma-separated list of properties to order results by, with optional direction (e.g., Name desc).
- Expand Comma-separated list of related entities to expand in the response.

Output

The node outputs JSON data containing the downloaded team queue general statistics report. The structure typically includes an array of statistical records corresponding to the requested queue and time range, each record containing metrics such as call counts, wait times, and other relevant statistics.

If binary data is returned (e.g., a file download), it would represent the raw report content, but based on the provided information, the output is primarily JSON-formatted statistics.

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 HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate headers.

Troubleshooting

  • Common issues:

    • Invalid or missing required parameters (queueDnStr, startDt, endDt, waitInterval) will cause the API request to fail.
    • Incorrect date formats may lead to errors or empty results.
    • Network connectivity problems or incorrect server URL configuration can prevent successful API calls.
    • Insufficient permissions or expired API tokens will result in authentication errors.

  • Error messages:

    • Authentication failures usually indicate invalid or missing API credentials; verify and update them.
    • Validation errors from the API often specify which parameter is incorrect or missing; check input values carefully.
    • Timeout or connection errors suggest network issues; ensure the 3CX server is reachable.

Links and References

Discussion