3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve chat performance data for a specific queue. The "Get Queue Chat Performance Data" operation fetches detailed metrics about chat interactions within a given queue over a specified time range. This is useful for contact center managers or analysts who want to monitor and analyze chat queue performance, such as response times, participant engagement, or volume of chats handled.

Practical examples include:

  • Generating reports on chat queue efficiency during peak hours.
  • Monitoring participant types (e.g., agents vs. customers) in chat sessions.
  • Filtering and sorting chat performance data to identify trends or issues.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue to retrieve chat performance data for.
Start Dt The start date/time for the data retrieval period (format expected by the API).
End Dt The end date/time for the data retrieval period (format expected by the API).
Participant Type Numeric code representing the type of participant in the chat (e.g., agent, customer).
Options Additional query options to refine the data 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 the results by, with optional direction (asc/desc).
- Expand Comma-separated list of related entities to expand inline in the response.

Output

The node outputs JSON data containing the chat performance metrics for the specified queue and time range. The structure typically includes an array of records, each representing a chat session or aggregated metric, with properties depending on the selected fields and filters.

If binary data were involved (not indicated here), it would represent files or media related to chats, but this node focuses on JSON data only.

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 credentials.
  • The node uses standard HTTP headers accepting JSON responses.

Troubleshooting

  • Common Issues:

    • Incorrect or missing queue identifier (queueDnStr) will result in no data or errors.
    • Invalid date formats for startDt or endDt may cause the API to reject the request.
    • Insufficient permissions or expired API tokens can lead to authorization errors.
    • Improperly formatted OData filters or search queries might cause syntax errors from the API.

  • Error Messages:

    • 401 Unauthorized: Check that the API credentials are valid and have not expired.
    • 400 Bad Request: Verify that all required parameters are provided and correctly formatted.
    • 404 Not Found: Confirm that the queue identifier exists in the 3CX system.
    • 500 Internal Server Error: May indicate temporary server issues; retry after some time.

Links and References

Discussion