3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download extension statistics filtered by ring groups over a specified time period. It is useful for users who want to generate detailed reports on call activity and usage metrics within specific ring groups in their 3CX environment. For example, a telecom administrator could use this node to analyze call volumes or performance of different ring groups between two dates.

Properties

Name Meaning
Period From The start date/time for the report period. Usage: periodFrom={periodFrom}
Period To The end date/time for the report period. Usage: periodTo={periodTo}
Ring Group Dns The DNS identifier(s) of the ring group(s) to filter the statistics by. Usage: ringGroupDns={ringGroupDns}
Options Additional query options to customize the data retrieval:
- Top Show only the first n items
- Skip Skip the first n items
- Search Search items by search phrases (supports quoted 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 (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 downloaded extension statistics filtered by the specified ring groups and time period. The structure typically includes statistical metrics per extension within the ring groups, such as call counts, durations, and statuses. If binary data is included (not indicated here), it would represent downloadable report files or attachments.

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.

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/time strings accepted by the 3CX API.
  • Ring Group DNS errors: Verify that the provided ring group DNS identifiers exist and are correct.
  • API rate limits or connectivity issues: Check network connectivity and 3CX API availability.
  • Incorrect query options: Improperly formatted $filter, $orderby, or other OData-like query parameters may cause errors; validate syntax carefully.

Links and References

Discussion