3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system to retrieve user activity reports. Specifically, the "Get User Activity" operation under the "Report User Activity" resource fetches detailed activity data for users within a specified time period and context.

This node is beneficial in scenarios where businesses want to monitor call center or telephony user activities, analyze performance metrics, or generate reports on user interactions over calls. For example, a call center manager could use this node to extract user activity logs filtered by time zone, group, or extension DNS to evaluate agent productivity or call handling efficiency.

Properties

Name Meaning
Client Time Zone The client’s time zone to correctly interpret timestamps (e.g., clientTimeZone=America/New_York).
Period From Start date/time of the reporting period (e.g., periodFrom=2024-01-01T00:00:00Z).
Period To End date/time of the reporting period (e.g., periodTo=2024-01-31T23:59:59Z).
Group Number Identifier for the group whose user activity is being reported.
Extension Dns The DNS name of the extension to filter the report by specific telephony extensions.
Wait Interval A wait interval parameter, likely controlling polling or retry timing during data retrieval.
Include Queue Calls Boolean flag indicating whether to include calls from queues in the report (true or false).
Call Area Numeric code representing the call area scope for filtering the report.
Grouping Type Numeric code defining how the results should be grouped (e.g., by user, by call type).
Options Additional OData query options to refine the request:
- Top Limit the number of items returned (e.g., first n items).
- Skip Skip the first n items in the result set.
- Search Search phrase(s) to filter items by text matching.
- Filter Filter expression to restrict items by property values (e.g., State eq 'Connected').
- Count Boolean to include the count of total items in the response.
- Select Comma-separated list of properties to return (e.g., Id,Name).
- Orderby Property names and directions to order the results (e.g., Name desc).
- Expand Related entities to expand inline in the response.

Output

The node outputs JSON data containing the user activity report as retrieved from the 3CX API. This typically includes structured information about user calls, statuses, durations, and other relevant telephony metrics according to the applied filters and grouping.

If binary data were involved (e.g., recordings), it would be indicated here, but based on the provided details, the output is purely JSON-formatted report 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 with JSON headers to communicate with the 3CX API endpoint /xapi/v1.
  • No additional external dependencies are indicated.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid date formats for Period From or Period To may lead to errors or empty results.
    • Providing unsupported or malformed OData query options can cause request failures.
    • Network connectivity issues to the 3CX server will prevent data retrieval.

  • Error Messages:

    • Authentication errors usually indicate invalid or expired API tokens; re-authenticate or update credentials.
    • Validation errors on input parameters suggest checking the format and required fields.
    • Timeout or connection errors imply network problems or incorrect server URLs.

Links and References

Discussion