3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve detailed statistics about extensions grouped by ring groups within a specified time period. It is useful for administrators or analysts who want to monitor call activity, performance, and usage patterns of different ring groups in their telephony environment.

Typical use cases include:

  • Generating reports on call volumes and extension activity per ring group.
  • Analyzing peak usage times and trends over custom date ranges.
  • Filtering and sorting data to focus on specific ring groups or extension statuses.

For example, an administrator might use this node to get all extension statistics for a particular ring group between January 1st and January 31st, filtering only connected extensions and ordering results by call duration.

Properties

Name Meaning
Period From Start date/time for the statistics period (required). Usage: periodFrom={periodFrom}
Period To End date/time for the statistics period (required). Usage: periodTo={periodTo}
Ring Group Dns Identifier(s) of the ring group(s) to retrieve statistics for (required). Usage: ringGroupDns={ringGroupDns}
Options Additional query options to refine the data retrieval:
- Top Show only the first n items
- Skip Skip the first n items
- Search Search items by phrases; supports automatic quoting if needed
- Filter Filter items by property values (e.g., State eq 'Connected')
- Count Include count of items (boolean)
- Select Select specific properties to be returned (comma-separated list)
- Orderby Order items by property values (e.g., Name desc, CreatedAt asc)
- Expand Expand related entities (comma-separated list)

Output

The node outputs JSON data containing the requested extension statistics grouped by ring groups. The structure typically includes details such as extension identifiers, call counts, durations, states, and other relevant metrics depending on the selected properties and filters.

If binary data were involved (e.g., recordings), it would be summarized accordingly, but this node focuses on JSON statistical 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 sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate query parameters.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API authentication token and server URL are correctly set up in the node's credentials.
  • Invalid date formats: The Period From and Period To fields must be valid date/time strings recognized by the 3CX API.
  • Incorrect ring group identifiers: Verify that the Ring Group Dns value corresponds to existing ring groups in your 3CX system.
  • Query option errors: Improper syntax in filter, search, or orderby options can cause API errors. Use correct OData-like syntax.
  • Empty results: May indicate no data available for the specified period or filters; try broadening the query parameters.

Links and References

Discussion