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 grouped by a specified group number within a given time period. It is useful for generating reports on call activity and usage metrics for specific groups in an organization, helping administrators monitor performance and resource utilization.

Typical use cases include:

  • Fetching call statistics for a department or team identified by a group number.
  • Analyzing call volume and patterns over a custom date range.
  • Filtering and sorting report data based on various criteria such as call area or search terms.

Properties

Name Meaning
Group Number The identifier of the group for which to retrieve extension statistics (required).
Period From The start date/time of the reporting period (required).
Period To The end date/time of the reporting period (required).
Call Area Numeric code representing the call area filter (required).
Options Additional query options to refine the results:
- Top Limit the number of returned items 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 filter items by property values (e.g., State eq 'Connected').
- Count Boolean flag to include the count of items in the response.
- Select Comma-separated list of properties to return for each item.
- Orderby Comma-separated list of properties to order the results by, with optional direction (asc/desc).
- Expand Comma-separated list of related entities to expand in the response.

Output

The node outputs JSON data containing the extension statistics for the specified group and period. The structure typically includes an array of records, each representing statistical data points such as call counts, durations, or statuses filtered and sorted according to the input parameters.

If binary data were involved (e.g., recordings), it would be summarized accordingly, 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 to the 3CX API endpoint /xapi/v1 to fetch data.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API key and server URL are correctly configured.
  • Invalid date formats: The Period From and Period To must be valid date strings accepted by the API.
  • Incorrect group number: Verify that the group number exists and is correct; otherwise, the API may return empty results.
  • Query option errors: Improperly formatted OData filters or search queries can cause API errors; validate syntax carefully.
  • Network issues: Check connectivity to the 3CX server and firewall settings if requests fail.

Common error messages might include authentication failures, invalid parameter errors, or timeout errors. Resolving these usually involves checking credentials, input formats, and network access.

Links and References

Discussion