3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve ring group statistics data for a specified time period and ring group. It is useful for monitoring call activity, performance, and usage patterns within specific ring groups in a 3CX phone system. Typical use cases include generating reports on call volumes, analyzing peak usage times, or auditing ring group behavior over custom date ranges.

For example, a user can specify a start and end date along with a particular ring group identifier to fetch detailed statistics about calls handled by that ring group during that period.

Properties

Name Meaning
Period From The start date/time of the reporting period (e.g., 2023-01-01T00:00:00Z).
Period To The end date/time of the reporting period (e.g., 2023-01-31T23:59:59Z).
Ring Group Dns The DNS name or identifier of the ring group for which statistics are requested.
Options Additional query options to refine the data retrieval:
- Top Limit the number of returned items to the first n entries.
- Skip Skip the first n items in the result set.
- Search Search items by phrases; supports quoted phrases for exact matches.
- Filter Filter results by property values (e.g., State eq 'Connected').
- Count Include the count of total items matching the query.
- Select Specify which properties to return (e.g., Id,Name).
- Orderby Order results by specified properties (e.g., Name desc, CreatedAt asc).
- Expand Expand related entities in the response (e.g., related objects or metadata).

Output

The node outputs JSON data containing the ring group statistics retrieved from the 3CX API. This typically includes metrics such as call counts, durations, states, timestamps, and other relevant call details aggregated per the specified parameters.

If binary data were involved (e.g., recordings), it would be included in the binary output field, but this node focuses on JSON statistical data only.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token or OAuth2 credential configured in n8n to authorize requests.
  • The base URL for the 3CX API must be provided in the credentials configuration.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate query parameters.

Troubleshooting

  • Invalid Date Format: Ensure Period From and Period To are in ISO 8601 format or accepted date string formats. Incorrect formats may cause API errors.
  • Unauthorized Access: Verify that the API credentials are valid and have sufficient permissions to access ring group statistics.
  • Ring Group Not Found: Confirm that the Ring Group Dns value corresponds to an existing ring group in the 3CX system.
  • Empty Results: Check filter and search options; overly restrictive queries might return no data.
  • API Rate Limits: If many requests are made in a short time, the API might throttle or reject requests. Implement retries or backoff strategies if needed.

Links and References

Discussion