3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve detailed queue statistics data. Specifically, the "Get Detailed Queue Statistics Data" operation under the "Report Detailed Queue Statistics" resource allows users to query detailed metrics about call queues within a specified time range. This is useful for contact center managers or telephony administrators who want to analyze queue performance, wait times, and call handling details.

Practical examples include:

  • Extracting queue statistics for a specific queue during business hours to evaluate agent performance.
  • Monitoring wait intervals and call volumes over a custom date range to optimize staffing.
  • Filtering and sorting queue data to identify bottlenecks or peak load times.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue to report on. Usage format: queueDnStr={queueDnStr}
Start Dt The start date/time for the statistics query. Usage format: startDt={startDt}
End Dt The end date/time for the statistics query. Usage format: endDt={endDt}
Wait Interval The wait interval parameter for the query. Usage format: waitInterval={waitInterval}
Options Additional OData-style query options to refine the results:
- Top Show only the first n items
- Skip Skip the first n items
- Search Search items by search phrases (supports phrase quoting)
- 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 containing the detailed queue statistics retrieved from the 3CX API. The structure typically includes an array of queue statistic records matching the query parameters, each with properties such as timestamps, queue identifiers, wait times, call counts, and other relevant metrics.

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

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node configuration must include the base URL of the 3CX server.
  • The node uses HTTP requests with JSON responses, relying on the 3CX REST API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect date formats for startDt or endDt may result in errors or empty responses.
    • Providing invalid OData query options (e.g., malformed $filter or $orderby) can cause request failures.
    • Network connectivity problems to the 3CX server will prevent data retrieval.

  • Error messages:

    • Authentication errors usually indicate invalid or expired API tokens; re-authenticate or update credentials.
    • Validation errors on input parameters suggest checking the required formats and mandatory fields.
    • HTTP 404 or 400 errors may mean incorrect endpoint usage or malformed queries; verify property names and query syntax.

Links and References

Discussion