3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve performance overview data for a specific queue within a given time period. It is useful for monitoring and analyzing call queue metrics such as wait times, call volumes, and agent performance in contact centers using 3CX. Practical applications include generating reports on queue efficiency, identifying bottlenecks, and optimizing resource allocation.

Properties

Name Meaning
Period From The start date/time of the reporting period (format expected by the API).
Period To The end date/time of the reporting period (format expected by the API).
Queue Dns The DNS identifier of the queue to retrieve performance data for.
Wait Interval The interval duration used to segment wait time data in the report.
Options Additional query options to customize the data retrieval:
- Top Limit the number of items returned to the first n entries.
- Skip Skip the first n items in the result set.
- Search Search items by phrases; supports quoted phrases for exact matches.
- Filter Filter items based on property values (e.g., "State eq 'Connected'").
- Count Include the count of items in the response (boolean).
- Select Specify which properties to return (comma-separated list).
- Orderby Order results by specified properties and directions (e.g., "Name desc").
- Expand Expand related entities in the response (comma-separated list).

Output

The node outputs JSON data containing the queue performance overview metrics for the specified period and queue. This typically includes aggregated statistics such as call counts, average wait times, service levels, and other relevant KPIs. The output structure directly reflects the API response from the 3CX system's queue performance endpoint.

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

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The base URL for the 3CX API must be provided via credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Missing or invalid credentials: Ensure the API authentication token and server URL are correctly configured.
  • Invalid date formats: The Period From and Period To fields must be in the format accepted by the 3CX API; otherwise, the request may fail.
  • Queue DNS not found: Verify that the Queue Dns value corresponds to an existing queue in the 3CX system.
  • API rate limits or connectivity issues: Network problems or API throttling can cause errors; check network access and retry policies.
  • Incorrect query options: Invalid filter, search, or orderby syntax may lead to API errors; consult 3CX API documentation for correct usage.

Links and References

Discussion