3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download call distribution reports. Specifically, the "Report Call Distribution" resource with the "Download Get Get Call Distribution" operation allows users to retrieve detailed call distribution data for a specified period and group configuration. This is useful for analyzing call handling performance, queue management, and extension activity within an organization.

Practical examples include:

  • Downloading call distribution reports for a specific group number over a defined time range.
  • Filtering call data by extension DNS or including/excluding queue calls.
  • Adjusting report granularity using grouping types and call areas.
  • Using query options to paginate, filter, or sort the returned data.

Properties

Name Meaning
Client Time Zone The client’s time zone to correctly interpret date/time values in the report.
Period From Start date/time of the reporting period (e.g., "2024-01-01T00:00:00").
Period To End date/time of the reporting period (e.g., "2024-01-31T23:59:59").
Group Number Identifier of the group for which the call distribution report is requested.
Extension Dns DNS name of the extension involved in the call distribution.
Wait Interval Time interval used for waiting or grouping calls in the report.
Include Queue Calls Boolean flag indicating whether to include calls handled by queues in the report.
Call Area Numeric code representing the area or scope of calls to include in the report.
Grouping Type Numeric code defining how calls are grouped in the report (e.g., by time, extension, etc.).
Options Collection of optional OData-like query parameters to refine the request:
- Top: Show only the first n items
- Skip: Skip the first n items
- Search: Search items by phrases
- Filter: Filter items by property values (e.g., "State eq 'Connected'")
- Count: Include count of items
- Select: Select properties to be returned
- Orderby: Order items by property values
- Expand: Expand related entities

Output

The node outputs JSON data containing the call distribution report matching the specified criteria. The structure typically includes details about calls such as timestamps, durations, extensions, groups, and queue information depending on the filters and grouping applied.

If binary data output is supported (not explicitly shown here), it would represent downloadable report files (e.g., CSV or Excel). However, based on the provided code and properties, the output is primarily JSON-formatted 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.
  • The node 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:

    • 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.
    • Providing invalid group numbers or extension DNS names can lead to no data being returned.
    • Misconfigured boolean flags like Include Queue Calls might exclude expected data.
    • Improper use of query options (e.g., malformed $filter or $orderby) could cause API errors.

  • Error messages:

    • Authentication errors usually indicate invalid or expired API tokens; re-authenticate or update credentials.
    • Validation errors on input parameters suggest checking the format and required fields.
    • API rate limits or server errors require retrying after some time or contacting the 3CX administrator.

Links and References

Discussion