3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve data about failed callbacks in a specific queue within a given time range. It is useful for monitoring and reporting on callback failures, helping administrators or support teams identify issues with call queues and improve customer service.

A practical example would be fetching all failed callback attempts from a particular queue between two dates to analyze patterns or troubleshoot problems.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue to query (e.g., queueDnStr=queue1). Required.
Start Dt The start date/time for the data retrieval period. Required.
End Dt The end date/time for the data retrieval period. Required.
Options Additional optional query parameters:
- Top Show only the first n items.
- Skip Skip the first n items.
- Search Search items by search phrases. If multiple words are provided without quotes, they will be quoted automatically.
- Filter Filter items by property values (e.g., "State eq 'Connected'").
- Count Include count of items (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 (e.g., "RelatedEntity1,RelatedEntity2").

Output

The node outputs JSON data representing the failed callback records retrieved from the 3CX system based on the specified queue and date range. The structure corresponds to the queried data fields and any selected expansions or filters applied.

If binary data were involved, it would typically represent media files or recordings, but this operation focuses on JSON data about failed callbacks.

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.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API authentication token and server URL are correctly set up.
  • Invalid date formats: The Start Dt and End Dt must be valid date strings recognizable by the API.
  • Empty or incorrect queue identifier: The Queue Dn Str must correspond to an existing queue in the 3CX system.
  • API errors due to query options: Incorrect syntax in filter, orderby, or other OData-like query parameters may cause errors; verify their correctness.
  • Network connectivity issues: Confirm that the n8n instance can reach the 3CX server URL.

Links and References

Discussion