3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve statistics about agents in a specific queue over a defined time interval. It is useful for monitoring call center performance, analyzing agent activity, and generating reports on queue handling efficiency.

Typical use cases include:

  • Fetching detailed agent statistics for a given queue within a specified date range.
  • Filtering and sorting agent data to focus on particular metrics or agents.
  • Integrating 3CX queue statistics into dashboards or automated reporting workflows.

For example, a user might want to get all agent statistics for queue "SalesQueue" from January 1st to January 31st, including only connected agents, ordered by their total talk time.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue to query (e.g., queueDnStr=SalesQueue).
Start Dt The start date/time for the statistics interval (e.g., startDt=2024-01-01T00:00:00Z).
End Dt The end date/time for the statistics interval (e.g., endDt=2024-01-31T23:59:59Z).
Wait Interval The wait interval parameter defining how wait times are considered or grouped.
Options Additional optional query parameters to refine the request:
- Top Show only the first n items (pagination).
- Skip Skip the first n items (pagination offset).
- Search Search items by phrases; supports quoted phrases for exact matches.
- Filter Filter items by property values (e.g., State eq 'Connected').
- Count Include count of items in the response (boolean).
- Select Select specific properties to be returned (e.g., Id,Name).
- Orderby Order items by property values (e.g., Name desc, CreatedAt asc).
- Expand Expand related entities in the response (e.g., RelatedEntity1,RelatedEntity2).

Output

The node outputs JSON data containing the agents' statistics for the specified queue and time interval. The structure typically includes an array of agent records with their respective metrics such as connection state, talk time, wait time, and other relevant statistics.

If binary data were involved (e.g., recordings), it would be summarized accordingly, but this node focuses on JSON statistical 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 sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate headers.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API authentication token or OAuth2 credentials are correctly set up in n8n.
  • Invalid date formats: The Start Dt and End Dt must be valid ISO 8601 date strings; otherwise, the API may reject the request.
  • Queue not found: If the Queue Dn Str does not correspond to an existing queue, the API will return an error or empty results.
  • API rate limits or connectivity issues: Network problems or API throttling can cause errors; verify network access and API usage limits.
  • Incorrect filter or query options: Malformed OData queries in options like $filter or $orderby can lead to API errors; validate syntax carefully.

Links and References

Discussion