3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve aggregated chat statistics for agents in a specific queue. It is designed to fetch total chat-related metrics for queue agents over a defined time period, filtered by participant type and other optional query parameters.

Common scenarios where this node is beneficial include:

  • Monitoring agent performance in handling chats within a call center queue.
  • Generating reports on chat volumes and agent activity for management review.
  • Integrating chat statistics into dashboards or analytics platforms.

For example, a user can specify a particular queue identifier, a date range, and participant type to get summarized chat statistics of agents who handled chats during that period.

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 data retrieval period (inclusive).
End Dt The end date/time for the data retrieval period (inclusive).
Participant Type Numeric code representing the type of participant to filter the statistics by (e.g., agent).
Options Optional query parameters to refine the data request:
- Top Limit the number of returned items to the first n entries.
- Skip Skip the first n items in the result set.
- Search Search phrase(s) to filter items by matching text.
- 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 aggregated chat statistics totals for queue agents based on the input parameters. The structure typically includes statistical fields such as counts, durations, or other relevant metrics per agent or queue.

If binary data were involved (e.g., files or media), it would be indicated here, but this node focuses on JSON data output only.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in the credentials.
  • The node uses HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate headers.

Troubleshooting

  • Missing or invalid credentials: Ensure the API key and server URL are correctly configured in the node credentials.
  • Invalid date formats: The Start Dt and End Dt must be valid date strings accepted by the 3CX API.
  • Incorrect queue identifier: Verify that the Queue Dn Str matches an existing queue in the 3CX system.
  • API rate limits or connectivity issues: Check network connectivity and API usage limits.
  • Malformed filter or query options: Ensure OData filters and other query parameters follow correct syntax.

Error messages from the API will typically indicate authentication failures, invalid parameters, or resource not found errors. Review these messages and adjust inputs accordingly.

Links and References

Discussion