3CX icon

3CX

Interact with 3CX telephony system

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve report data specifically related to queue abandoned calls ("Queue An Un Calls"). The operation "Get Queue An Un Calls Data" fetches detailed metrics about abandoned calls in a specified queue, filtered and grouped by various parameters such as date, time zone, and queue identifier.

Typical use cases include:

  • Monitoring call center performance by analyzing abandoned call trends.
  • Generating reports for management on queue efficiency.
  • Integrating telephony data into dashboards or analytics platforms.

For example, a user might configure this node to get the count of abandoned calls for a particular queue on a specific date, grouped by hour, to identify peak times when callers abandon calls.

Properties

Name Meaning
Chart Date The date for which the report data is requested. Usage format: chartDate={chartDate}
Chart By The dimension by which to group the chart data (e.g., by hour, day). Usage: chartBy={chartBy}
Queue Dn Str The identifier string of the queue to report on. Usage: queueDnStr={queueDnStr}
Client Time Zone The client's time zone to correctly localize the report data. Usage: clientTimeZone={clientTimeZone}
Wait Interval The wait interval parameter affecting how waiting times are considered in the report. Usage: waitInterval={waitInterval}
Options Additional query options to refine the request:
- Top Show only the first n items
- Skip Skip the first n items
- Search Search items by phrases (supports quoted phrases)
- Filter Filter items by property values (e.g., State eq 'Connected')
- Count Include count of items (boolean)
- Select Select specific properties to be returned (comma-separated list)
- Orderby Order items by property values (e.g., Name desc, CreatedAt asc)
- Expand Expand related entities

Output

The node outputs JSON data containing the requested report information about queue abandoned calls. The structure typically includes metrics grouped by the specified "Chart By" parameter (such as time intervals), along with counts and other relevant statistics about abandoned calls in the specified queue.

If binary data were involved (e.g., audio recordings), it would be summarized here, but this node focuses on JSON report 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

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid or improperly formatted input parameters (e.g., wrong date format) may result in empty or error responses.
    • Network connectivity problems to the 3CX server can cause request timeouts or failures.
  • Error messages:

    • Authentication errors usually indicate invalid or expired API tokens; re-authenticate or update credentials.
    • Validation errors on parameters suggest checking the required formats and ensuring all mandatory fields are provided.
    • Server errors from 3CX may require checking server status or logs.

Links and References

Discussion