3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download reports on average queue waiting times. Specifically, the "Download Average Queue Waiting Time Report" operation retrieves detailed metrics about how long calls wait in queues within the 3CX system. This is useful for contact center managers or telephony administrators who want to analyze call handling efficiency and optimize resource allocation.

Practical examples include:

  • Downloading daily average queue waiting time reports to monitor call center performance.
  • Filtering reports by specific queues or time intervals to identify bottlenecks.
  • Exporting data for further analysis or integration with other business intelligence tools.

Properties

Name Meaning
Chart Date The date for which the average queue waiting time report is requested (format as string).
Chart By The dimension or metric by which the chart/report is grouped or categorized.
Queue Dn Str The identifier string of the queue(s) for which the report is generated.
Wait Interval The time interval over which waiting times are aggregated or reported.
Client Time Zone The timezone context used for the report's timestamps and calculations.
Options Additional query options to customize the report output:
- 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.
- Count Boolean flag to include a count of total items in the response.
- Select Comma-separated list of properties to return in each item.
- Orderby Property names and directions to order the results by (e.g., "Name desc").
- Expand Related entities to expand inline in the response.

Output

The node outputs JSON data representing the average queue waiting time report according to the specified parameters. The structure typically includes:

  • Metrics grouped by the chosen "Chart By" dimension.
  • Aggregated waiting time statistics per queue or time interval.
  • Metadata such as timestamps adjusted to the client time zone.
  • Pagination or count information if requested via options.

If binary data were involved (e.g., file downloads), it would be summarized here, but this node appears to focus on JSON report 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.
  • Uses HTTP requests with JSON headers to communicate with the 3CX API endpoint /xapi/v1.
  • No additional external dependencies beyond the 3CX API and its OAuth2 authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect date or queue identifiers may result in empty or error responses.
    • Misformatted OData filters or query options can lead to request errors.
    • Timezone mismatches might cause confusion interpreting report timestamps.

  • Error messages:

    • Authentication errors: Verify that the API key and server URL are correctly configured.
    • 400 Bad Request: Check the formatting of input parameters like dates, filters, and search strings.
    • 404 Not Found: Ensure the specified queue or resource exists in the 3CX system.
    • Rate limiting or server errors: Retry after some time or check 3CX server health.

Links and References

Discussion