3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node operation, Download Queue Agents Chat Statistics, is designed to retrieve detailed chat statistics for agents in a specific queue within a telephony system. It allows users to specify the queue, date range, and participant type to generate reports on agent chat activity. This is particularly useful for contact center managers or supervisors who want to analyze agent performance, monitor chat volumes, or generate historical reports for operational insights.

Practical examples:

  • Downloading chat statistics for all agents in a sales queue over the last week to evaluate workload distribution.
  • Generating reports filtered by participant type (e.g., agent vs. customer) to understand interaction patterns.
  • Using query options like filtering or ordering to focus on top-performing agents or specific time frames.

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 report data range (inclusive).
End Dt The end date/time for the report data range (inclusive).
Participant Type Numeric code representing the type of participant to include in the report (e.g., agent, customer).
Options Additional query options to customize 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 total count of items in the response.
- Select Comma-separated list of properties to return for each item (e.g., Id,Name).
- Orderby Comma-separated list of properties to order results by, with optional direction (e.g., Name desc).
- Expand Comma-separated list of related entities to expand inline in the response.

Output

The node outputs JSON data containing the requested queue agents chat statistics. The structure typically includes an array of records, each representing an agent's chat statistics within the specified parameters. Each record may contain fields such as agent identifiers, chat counts, durations, states, timestamps, and other relevant metrics depending on the API response.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system's API.
  • The base URL for the API must be configured in the node credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate query parameters based on input properties.

Troubleshooting

  • Common issues:

    • Invalid or missing queue identifier (queueDnStr) will cause the API to reject the request.
    • Incorrect date formats for startDt or endDt may lead to errors or empty responses.
    • Insufficient permissions or invalid API credentials can result in authentication failures.
    • Improperly formatted OData queries in options like $filter or $orderby may cause syntax errors from the API.

  • Error messages:

    • Authentication errors: Check that the API key credential is correctly configured and has necessary permissions.
    • Validation errors: Verify that required fields (queueDnStr, startDt, endDt, participantType) are provided and correctly formatted.
    • Query parameter errors: Review any advanced query options for correct syntax and supported values.

Links and References

Discussion