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 queue answered calls categorized by wait time. It is useful for call center managers or administrators who want to analyze how long callers waited before their calls were answered in a specific queue during a given time period. For example, it can help identify peak times with longer wait times or evaluate the performance of call queues.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue to report on (e.g., a queue extension number).
Start Dt The start date/time for the report data range.
End Dt The end date/time for the report data range.
Answer Interval The interval grouping for answered calls by wait time (e.g., 0-10 seconds, 11-20 seconds).
Client Time Zone The time zone context for the client requesting the report (affects date/time interpretation).
Options Additional query options to customize the report output:
- 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(s) to filter items by text matching.
- Filter Filter expression to restrict items by property values (e.g., "State eq 'Connected'").
- Count Boolean flag to include the count of items in the response.
- Select Specify which properties to return (e.g., "Id,Name").
- Orderby Define ordering of items by property values (e.g., "Name desc").
- Expand Expand related entities in the response.

Output

The node outputs JSON data representing the downloaded report of queue answered calls by wait time. This JSON typically includes details such as call counts grouped by wait time intervals, timestamps, and queue identifiers. The exact structure depends on the API response but generally provides an array of records summarizing answered calls within the specified parameters.

No binary data output is indicated.

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 and query parameters.

Troubleshooting

  • Common issues:
    • Incorrect or missing required parameters like queueDnStr, startDt, or endDt may cause request failures.
    • Invalid date formats or time zones can lead to unexpected results or errors.
    • Network connectivity or authentication failures with the 3CX server will prevent data retrieval.
  • Error messages:
    • Authentication errors indicate invalid or expired API credentials; reconfigure the API key.
    • Validation errors usually specify which required parameter is missing or malformed.
    • API rate limits or server errors should be retried after some delay or checked with the 3CX administrator.

Links and References

Discussion