3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve general statistics data for a team queue. Specifically, the "Get Team Queue General Statistics Data" operation fetches statistical information about a specified queue within a given time range. This is useful for monitoring call center performance, analyzing team workload, and generating reports on queue activity.

Practical examples include:

  • Retrieving the number of calls handled by a team queue during a shift.
  • Analyzing wait times and service levels for calls in a specific queue.
  • Generating periodic reports on queue performance metrics for management review.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue to retrieve statistics for. Usage: queueDnStr={value}
Start Dt The start date/time for the statistics data range. Usage: startDt={value}
End Dt The end date/time for the statistics data range. Usage: endDt={value}
Wait Interval The interval used to calculate wait times or related metrics. Usage: waitInterval={value}
Options Additional query options to refine the data retrieval:
- 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

Output

The node outputs JSON data containing the requested team queue general statistics. The structure typically includes statistical metrics such as call counts, wait times, service levels, and other relevant queue performance indicators. The exact fields depend on the 3CX API response for the specified query parameters.

No binary data output is indicated.

Dependencies

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

Troubleshooting

  • Common issues:

    • Invalid or missing queue identifier (queueDnStr) will result in no data or errors.
    • Incorrect date formats for startDt or endDt may cause request failures.
    • Insufficient permissions or invalid API credentials can lead to authentication errors.
    • Overly broad queries without filters or limits might return large datasets causing timeouts.

  • Error messages:

    • Authentication errors: Verify that the API key credential is correctly set up and has necessary permissions.
    • Validation errors: Check that required parameters (queueDnStr, startDt, endDt, waitInterval) are provided and correctly formatted.
    • API rate limiting or server errors: Retry after some time or check 3CX server status.

Links and References

Discussion