3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve call cost data grouped by extension groups. Specifically, the "Get Call Cost By Extension Group Data" operation allows users to query detailed call cost information for a specified period and group filter. This is useful for telecom administrators or finance teams who want to analyze call expenses by department, team, or any logical grouping of extensions within their organization.

Practical examples include:

  • Generating monthly reports on call costs per department.
  • Filtering call cost data for specific extension groups during a promotional period.
  • Analyzing call cost trends over custom date ranges.

Properties

Name Meaning
Period From Start date/time of the period to retrieve call cost data (usage: periodFrom={periodFrom}).
Period To End date/time of the period to retrieve call cost data (usage: periodTo={periodTo}).
Group Filter Filter string to specify which extension groups to include in the report (usage: groupFilter={groupFilter}).
Call Class Numeric value representing the call classification to filter by (usage: callClass={callClass}).
Options Additional query options to refine the results:
- Top Show only the first n items.
- Skip Skip the first n items.
- Search Search items by search phrases.
- Filter Filter items by property values (e.g., State eq 'Connected').
- Count Include count of items (boolean).
- Select Select specific properties to be returned (e.g., Id,Name).
- Orderby Order items by property values (e.g., Name desc, CreatedAt asc).
- Expand Expand related entities (e.g., RelatedEntity1,RelatedEntity2).

Output

The node outputs JSON data containing the call cost details grouped by extension groups according to the specified filters and options. The structure typically includes fields such as extension group identifiers, call cost amounts, call counts, and possibly metadata about the calls.

If binary data output is supported, it would represent attachments or reports related to the call cost data, but this is not indicated in the provided source.

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 responses from the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect date formats for "Period From" or "Period To" may result in errors or empty data.
    • Improperly formatted filters or unsupported query options can lead to API errors.
  • Error messages:
    • Authentication errors: Verify that the API key and server URL are correctly set.
    • Validation errors on input parameters: Ensure required fields are filled and follow expected formats.
    • API response errors: Check network connectivity and 3CX server status.

Links and References

Discussion