3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download ring group statistics reports. It is useful for users who want to retrieve detailed usage data about ring groups within a specified time period. Typical scenarios include monitoring call traffic, analyzing performance of ring groups, and generating reports for operational insights.

For example, a user can specify a date range and a particular ring group identifier (DNS) to download statistics such as call counts, durations, or other metrics related to that ring group during the selected period.

Properties

Name Meaning
Period From The start date/time of the reporting period. Format expected as a string.
Period To The end date/time of the reporting period. Format expected as a string.
Ring Group Dns The DNS identifier of the ring group for which statistics are requested.
Options Additional query options to customize the report output:
- Top Show only the first n items in the result.
- Skip Skip the first n items in the result.
- Search Search items by search phrases; supports phrase quoting automatically if needed.
- Filter Filter items by property values, e.g., "State eq 'Connected'".
- Count Include count of items in the response (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 downloaded ring group statistics for the specified period and ring group DNS. The structure typically includes an array of statistical records matching the query parameters and any metadata such as counts if requested.

If binary data were involved (e.g., file downloads), it would be summarized here, but this node returns JSON data representing the report.

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.
  • No additional external dependencies beyond the 3CX API and proper authentication.

Troubleshooting

  • Missing or invalid credentials: Ensure the API key and server URL are correctly set up in the node credentials.
  • Invalid date formats: The Period From and Period To fields must be valid date strings accepted by the 3CX API.
  • Ring Group DNS not found: Verify the ring group DNS value corresponds to an existing ring group in your 3CX system.
  • API errors or rate limits: Check the 3CX server status and API usage limits.
  • Incorrect query options: Filters, search, or ordering syntax must conform to OData-like query standards used by the API.

Common error messages will relate to authentication failures, invalid parameters, or network issues. Resolving them involves verifying credentials, input formats, and connectivity.

Links and References

Discussion