3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node operation, Download Queue Agents Chat Statistics Totals, is designed to retrieve aggregated chat statistics for agents in a specific queue within the 3CX telephony system. It allows users to specify a queue identifier and a date range to download summarized chat data related to agent activities.

Typical use cases include:

  • Monitoring agent performance in handling chats over a given period.
  • Generating reports on chat volumes and agent engagement for management review.
  • Integrating chat statistics into dashboards or analytics platforms.

For example, a contact center manager could use this node to download total chat statistics for all agents in the "Support" queue between January 1st and January 31st to evaluate workload and efficiency.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue for which chat statistics are requested.
Start Dt The start date/time for the statistics data range (format as required by the API).
End Dt The end date/time for the statistics data range.
Participant Type Numeric value indicating the type of participant to filter statistics by (e.g., agent, customer).
Options Additional query options to refine the request:
- Top Limit the number of items returned to the first n entries.
- Skip Skip the first n items in the result set.
- Search Search phrase(s) to filter items by text matching.
- Filter OData-style filter expression to restrict results by property values (e.g., State eq 'Connected').
- Count Boolean flag to include the count of items in the response.
- Select Comma-separated list of properties to return for each item.
- Orderby Comma-separated list of properties to order the results by, with optional direction (asc/desc).
- Expand Comma-separated list of related entities to expand in the response.

Output

The node outputs JSON data containing the downloaded queue agents chat statistics totals. The structure typically includes aggregated metrics per agent or queue, such as counts of chats handled, durations, and other relevant statistics as provided by the 3CX API.

If binary data were involved (e.g., file downloads), it would be indicated here, but based on the operation name and properties, the output is JSON-formatted statistical data.

Dependencies

  • Requires an active connection to a 3CX telephony system via an API endpoint.
  • Needs an API authentication token or OAuth2 credential configured in n8n to authorize requests.
  • The base URL for the 3CX API must be correctly set in the node credentials.
  • The node uses standard HTTP headers accepting JSON responses.

Troubleshooting

  • Invalid Date Format: Ensure that Start Dt and End Dt are formatted according to the API's expected date/time format; otherwise, the API may reject the request.
  • Authentication Errors: Verify that the API key or OAuth2 credentials are valid and have sufficient permissions to access queue statistics.
  • Empty Results: If no data is returned, check that the queue identifier (Queue Dn Str) is correct and that the date range actually contains data.
  • Query Option Misuse: Incorrectly formatted OData filters or search strings can cause errors; validate syntax carefully.
  • API Endpoint Issues: Confirm that the base URL is reachable and does not have trailing slashes that might break the request URL.

Links and References

Discussion