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 grouped by a specified group number within a given time period. It is useful for generating detailed reports on call activity and extension usage for specific groups in an organization. Typical use cases include monitoring call volumes, analyzing team performance, or auditing telephony usage over custom date ranges.

For example, a user can specify a group number and a date range to retrieve call statistics for that group, optionally filtering or sorting the results to focus on particular extensions or call types.

Properties

Name Meaning
Group Number The identifier of the group for which to download extension statistics. Usage: groupNumber={value}
Period From Start date/time of the reporting period. Usage: periodFrom={value}
Period To End date/time of the reporting period. Usage: periodTo={value}
Call Area Numeric code representing the call area scope for the report. Usage: callArea={value}
Options Additional query options to refine the data returned:
- Top Show only the first n items
- Skip Skip the first n items
- Search Search items by 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 extension statistics for the specified group and period. The structure typically includes details about each extension's call metrics such as call counts, durations, and statuses depending on the API response.

If binary data is returned (not indicated here), it would represent downloadable report files or attachments, but this node primarily returns structured JSON 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 with appropriate query parameters based on input properties.

Troubleshooting

  • Invalid or missing group number: Ensure the "Group Number" property is correctly set and corresponds to an existing group in 3CX.
  • Date format errors: The "Period From" and "Period To" must be valid date strings accepted by the 3CX API.
  • Authentication failures: Verify that the API key credential is valid and has sufficient permissions.
  • API rate limits or connectivity issues: Check network access to the 3CX server and any firewall restrictions.
  • Incorrect query options: Filters, search phrases, or ordering syntax must follow OData conventions supported by the 3CX API.

Common error messages will relate to HTTP status codes like 401 Unauthorized (authentication issue), 400 Bad Request (invalid parameters), or 404 Not Found (invalid group or resource).

Links and References

Discussion