3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system to retrieve call distribution reports. Specifically, the "Get Call Distribution" operation under the "Report Call Distribution" resource fetches detailed call distribution data based on various filtering and grouping parameters. This is useful for analyzing call traffic patterns, monitoring queue performance, or generating usage statistics within a specified time frame.

Practical examples include:

  • Generating reports on how calls are distributed across different groups or extensions during business hours.
  • Monitoring queue call volumes and wait times to optimize staffing.
  • Filtering call data by specific time periods and client time zones for accurate reporting.

Properties

Name Meaning
Client Time Zone The client's time zone to adjust the report timing accordingly (e.g., "America/New_York").
Period From Start date/time of the reporting period (format as required by the API).
Period To End date/time of the reporting period.
Group Number Identifier for the group whose call distribution is being reported.
Extension Dns DNS name of the extension involved in the report.
Wait Interval Time interval used to calculate waiting times in the report.
Include Queue Calls Boolean flag indicating whether to include calls from queues in the report.
Call Area Numeric code representing the call area filter.
Grouping Type Numeric code specifying how the results should be grouped (e.g., by time, by group, etc.).
Options Additional query options to refine the request:
- Top Limit the number of items returned (pagination).
- Skip Number of items to skip (pagination offset).
- Search Search phrase to filter items.
- Filter OData-style filter expression to narrow down results (e.g., State eq 'Connected').
- Count Boolean to include the count of total items matching the query.
- Select Comma-separated list of properties to return.
- Orderby Property names and directions to order the results (e.g., Name desc).
- Expand Related entities to expand inline in the response.

Output

The node outputs JSON data containing the call distribution report according to the specified filters and grouping. The structure typically includes details such as call counts, durations, wait times, and grouping metadata depending on the API response.

If binary data were supported, it would represent downloadable report files or media, but this node focuses on JSON responses only.

Dependencies

  • Requires an active connection to a 3CX telephony system via an OAuth2 API credential.
  • The node expects the base URL of the 3CX server to be configured in credentials.
  • Proper permissions on the 3CX system to access call distribution reports are necessary.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid date formats for "Period From" or "Period To" may result in errors or empty responses.
    • Using unsupported grouping types or call areas might lead to unexpected results or API errors.
    • Network connectivity problems to the 3CX server can cause request timeouts.

  • Error messages:

    • Authentication errors: Verify that the OAuth2 token is valid and has not expired.
    • Validation errors: Check that all required fields are provided and correctly formatted.
    • API errors: Review the 3CX API documentation for limits and constraints on parameters.

Links and References

Discussion