3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing functionality to retrieve data about queue callbacks. The "Get Queue Callbacks Data" operation allows users to query callback records from a specified queue within a given date range. This is useful for contact center managers or telephony administrators who want to analyze callback activity, monitor queue performance, or generate reports on customer interactions.

Practical examples include:

  • Fetching all callback records for a particular queue during a business day.
  • Filtering callbacks by status or other properties using OData-style query options.
  • Paginating results to handle large datasets efficiently.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue to query callbacks for. Usage format: queueDnStr={queueDnStr}
Start Dt The start date/time for the query range. Usage format: startDt={startDt}
End Dt The end date/time for the query range. Usage format: endDt={endDt}
Options Additional query options to refine the data retrieval. These include:
- Top: Show only the first n items
- Skip: Skip the first n items
- Search: Search items by search 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 (e.g., Id,Name)
- Orderby: Order items by property values (e.g., Name desc, CreatedAt asc)
- Expand: Expand related entities

Output

The node outputs JSON data representing the queue callback records retrieved from the 3CX system. Each item in the output corresponds to a callback entry with its associated properties as returned by the API. The structure depends on the selected fields and filters but generally includes details such as callback identifiers, timestamps, queue information, and callback statuses.

If binary data were involved (not indicated here), it would typically represent media files or recordings related to callbacks, but this node focuses on 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.
  • Uses HTTP requests to the 3CX API endpoint /xapi/v1.
  • Supports OData query parameters for filtering, searching, and pagination.

Troubleshooting

  • Missing or invalid credentials: Ensure that the API authentication token and server URL are correctly set up in the node credentials.
  • Invalid date formats: The Start Dt and End Dt must be provided in a valid date/time string format recognized by the 3CX API.
  • Empty or incorrect queue identifier: The Queue Dn Str must correspond to an existing queue; otherwise, no data will be returned.
  • API rate limits or connectivity issues: Network problems or API throttling may cause errors; verify network access and API usage limits.
  • Incorrect OData query syntax: Filters, search, and orderby parameters must follow correct syntax; otherwise, the API may return errors.

Links and References

Discussion