3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download extension usage statistics for a specified period and filter criteria. It is useful for administrators or analysts who want to retrieve detailed reports on extension activity within their 3CX environment, such as call volumes, usage patterns, or performance metrics.

Typical use cases include:

  • Generating reports on extension usage over a custom date range.
  • Filtering statistics by specific extensions or call areas.
  • Paginating and sorting large datasets of extension statistics.
  • Searching and filtering data based on custom query parameters.

For example, an administrator might use this node to download statistics for all extensions in a particular call area between January 1 and January 31, filtering only active extensions and ordering results by call volume.

Properties

Name Meaning
Period From Start date/time for the statistics period (usage: periodFrom={periodFrom}).
Period To End date/time for the statistics period (usage: periodTo={periodTo}).
Extension Filter Filter string to specify which extensions to include (usage: extensionFilter={extensionFilter}).
Call Area Numeric identifier specifying the call area to filter statistics by (usage: callArea={callArea}).
Options Collection of optional query parameters to refine the request:
- 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 requested extension statistics according to the specified filters and options. The structure typically includes an array of extension statistic objects with properties such as extension identifiers, usage metrics, timestamps, and other relevant details depending on the API response.

If binary data were involved (e.g., file downloads), it would be summarized here, but this node focuses on JSON 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 responses.
  • No additional external dependencies beyond the 3CX API and n8n's HTTP capabilities.

Troubleshooting

  • Invalid Date Range: Ensure that "Period From" and "Period To" are valid date strings and that "Period From" is earlier than "Period To".
  • Authentication Errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Filtering Issues: Incorrect filter syntax may cause errors; use proper OData-like query syntax for $filter, $search, etc.
  • Empty Results: Check that the extension filter and call area values match existing data; try broadening filters.
  • API Rate Limits: Large queries with high $top values may hit rate limits; use pagination ($skip) to manage data size.

Links and References

Discussion