3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download reports on abandoned queue calls. It is useful for contact center managers or administrators who want to analyze call abandonment patterns within specific queues over a defined time period. For example, it can help identify peak times when callers abandon calls, enabling better staffing and queue management.

The "Download Abandoned Queue Calls" operation fetches detailed data about calls that were abandoned in a specified queue between two dates, considering client time zone and wait interval parameters.

Properties

Name Meaning
Period From Start date/time of the reporting period (format as required by the API).
Period To End date/time of the reporting period.
Queue Dns The DNS name or identifier of the queue to report on.
Wait Interval The wait interval parameter to filter or group abandoned calls.
Client Time Zone The time zone of the client making the request, used to adjust date/time values accordingly.
Options Additional query options to customize the request:
- Top Show only the first n items.
- Skip Skip the first n items.
- Search Search items by search 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 (comma-separated list).

Output

The node outputs JSON data representing the abandoned queue calls matching the specified criteria. The structure typically includes details such as call identifiers, timestamps, queue information, and possibly caller metadata depending on the API response.

If binary data is returned (not indicated here), it would represent downloadable report files or attachments, but this node primarily returns structured JSON 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 requests to the 3CX API endpoint /xapi/v1 with appropriate headers.
  • No other external dependencies are indicated.

Troubleshooting

  • Invalid Date Format: Ensure "Period From" and "Period To" are correctly formatted according to the API requirements.
  • Authentication Errors: Verify that the API key credential is valid and has necessary permissions.
  • Queue DNS Not Found: Confirm that the provided queue DNS matches an existing queue in the 3CX system.
  • Empty Results: Check filters and search parameters; also verify the date range covers periods with data.
  • API Rate Limits: If many requests are made, consider adding delays or reducing query size using $top and $skip.

Links and References

  • 3CX Official API Documentation (refer to your 3CX version's API docs for detailed parameters and examples)
  • n8n Documentation on HTTP Request Nodes and Credential Setup

Discussion