3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve average queue waiting time data. It is useful for call center managers or administrators who want to monitor and analyze how long callers wait in queues on specific dates, by different criteria such as queue identifiers or time intervals. For example, a user can get the average waiting times for a particular queue on a given day, helping optimize staffing or identify peak load periods.

Properties

Name Meaning
Chart Date The date for which the average queue waiting time data is requested (format as string).
Chart By The dimension or metric by which the chart data should be grouped or categorized.
Queue Dn Str The identifier string of the queue(s) to retrieve data for.
Wait Interval The time interval over which to calculate the average waiting time.
Client Time Zone The timezone context to apply when interpreting date/time values.
Options Additional query options to refine the request:
- Top Limit the number of returned items to the first n entries.
- Skip Skip the first n items in the result set.
- Search Search phrase to filter items by text matching.
- Filter OData-style filter expression to restrict results by property values.
- Count Boolean flag to include the total count of items in the response.
- Select Comma-separated list of properties to return for each item.
- Orderby Property names and directions to order the results by.
- Expand Related entities to expand inline in the response.

Output

The node outputs JSON data containing the average queue waiting time information based on the input parameters. The structure typically includes records with fields corresponding to the selected properties, such as timestamps, queue identifiers, average wait times, and any expanded related entities if requested. There is no indication that binary data is output by this node.

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:
    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid date formats or unsupported time zones may lead to errors or empty results.
    • Improperly formatted OData filters or query options can cause the API to reject the request.
  • Error messages:
    • Authentication errors usually indicate invalid or expired API tokens; reconfigure credentials.
    • Validation errors on input properties suggest checking the format and required fields.
    • Network or server errors might require verifying the 3CX server URL and network connectivity.

Links and References

Discussion