3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve extension statistics data for a specified period and filter criteria. It is useful for generating reports on call activity, usage patterns, or performance metrics related to specific extensions within an organization’s phone system.

Typical use cases include:

  • Monitoring call volumes and durations for selected extensions over a given time frame.
  • Filtering statistics by extension identifiers and call areas to analyze specific segments.
  • Applying query options like sorting, filtering, and pagination to customize the report output.

For example, a user might request extension statistics from January 1 to January 31, filtered to a particular extension group, and sorted by call duration to identify the busiest extensions.

Properties

Name Meaning
Period From Start date/time of the reporting period (usage: periodFrom={periodFrom}).
Period To End date/time of the reporting period (usage: periodTo={periodTo}).
Extension Filter Filter string to specify which extensions to include in the report (usage: extensionFilter={extensionFilter}).
Call Area Numeric identifier representing the call area to filter statistics by (usage: callArea={callArea}).
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 extension statistics matching the specified filters and options. The structure typically includes statistical fields such as call counts, durations, extension identifiers, and other relevant metrics depending on the API response.

If binary data were involved (not indicated here), it would represent files or media related to the statistics, but this node focuses on JSON data output.

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 with appropriate headers.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API key and server URL are correctly set up in the node credentials.
  • Invalid date formats: The Period From and Period To must be valid date strings accepted by the 3CX API.
  • Incorrect filter syntax: Filters and query options must follow the expected OData-like syntax; otherwise, the API may return errors.
  • Empty results: Check that the extension filter and call area parameters match existing data; no matches will result in empty output.
  • API connectivity issues: Verify network access to the 3CX server and that the server URL is correct without trailing slashes.

Links and References

Discussion