3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download user activity reports. Specifically, the "Download Get User Activity" operation under the "Report User Activity" resource allows users to retrieve detailed activity data for users within a specified time period and configuration. This is useful for monitoring call center performance, tracking user engagement, or auditing telephony usage.

Practical examples include:

  • Downloading user call activity logs for a given date range to analyze peak call times.
  • Filtering user activity by groups or extensions to generate team-specific reports.
  • Including or excluding queue calls to focus on direct user interactions.

Properties

Name Meaning
Client Time Zone The client’s time zone to correctly interpret timestamps in the report (e.g., "America/New_York").
Period From Start date/time of the reporting period (format as required by the API).
Period To End date/time of the reporting period.
Group Number Identifier for the group whose user activity is being reported.
Extension Dns The extension DNS identifier related to the user or group.
Wait Interval Interval to wait between requests or processing steps (likely in milliseconds or seconds).
Include Queue Calls Boolean flag indicating whether to include calls handled via queues in the report.
Call Area Numeric code representing the call area filter (meaning depends on 3CX API documentation).
Grouping Type Numeric code specifying how results should be grouped (e.g., by user, by extension).
Options Collection of optional OData query parameters to refine the request:
- Top: Limit number of items returned.
- Skip: Number of items to skip from the start.
- Search: Search phrase(s) to filter items.
- Filter: Filter expression to narrow down results (e.g., "State eq 'Connected'").
- Count: Whether to include count of total items.
- Select: Comma-separated list of properties to return.
- Orderby: Property values to order results by (e.g., "Name desc").
- Expand: Related entities to expand in the response.

Output

The node outputs JSON data containing the user activity report retrieved from the 3CX system. The structure typically includes details such as user identifiers, call records, timestamps, durations, and other relevant metadata depending on the applied filters and options.

If binary data is included (not explicitly 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.
  • Uses OAuth2 authentication for secure API access.
  • The node relies on the 3CX API endpoint /xapi/v1 for fetching reports.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid date formats for Period From or Period To may result in errors or empty responses.
    • Using unsupported or incorrect values for numeric fields like Call Area or Grouping Type can lead to unexpected results.
    • Network connectivity problems to the 3CX server will prevent data retrieval.

  • Error messages:

    • Authentication errors usually indicate invalid or expired tokens; re-authenticate or update credentials.
    • Validation errors on input parameters suggest checking the format and required fields.
    • API rate limits or server errors might require retrying after some delay or contacting 3CX support.

Links and References

Discussion