3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download call cost reports grouped by extension groups. It is useful for organizations that want to analyze telephony expenses over specific periods, filtered by extension groups and call classifications. For example, a telecom administrator can use this node to generate detailed cost reports for different departments or teams within a company, helping to monitor and optimize communication costs.

Properties

Name Meaning
Period From The start date/time of the reporting period (format as required by the API).
Period To The end date/time of the reporting period.
Group Filter Filter to specify which extension groups to include in the report.
Call Class Numeric value representing the classification of calls to include (e.g., internal, external).
Client Time Zone Time zone context for the report data, ensuring correct time interpretation.
Options Additional query options to refine 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 narrow down results by property values.
- Count Boolean flag to include the count of total items in the response.
- Select Comma-separated list of properties to return for each item.
- 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 cost report grouped by extension group according to the specified filters and parameters. The structure typically includes details such as extension group identifiers, call cost summaries, and possibly metadata about the report period and applied filters.

If binary data is included (not indicated explicitly here), it would represent downloadable report files or attachments related to the call cost 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 to the 3CX API endpoint /xapi/v1 to fetch report data.

Troubleshooting

  • Invalid Date Range: Ensure "Period From" is earlier than "Period To". Incorrect ranges may cause errors or empty results.
  • Authentication Errors: Verify that the API key credential and server URL are correctly configured and valid.
  • Filter Syntax Issues: When using advanced filtering ($filter), ensure the syntax matches OData standards expected by the API.
  • Empty Results: Check that the group filter and call class parameters match existing data; otherwise, no records will be returned.
  • API Limits: Using large $top values or complex queries might hit API rate limits or timeout issues.

Links and References

Discussion