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 download report queue callbacks. This operation allows users to retrieve callback data for a specified queue within a given date range. It is useful in scenarios where call center managers or administrators want to analyze callback performance, monitor queue activity, or generate reports on callback metrics.

Practical examples include:

  • Downloading all callback records for a specific queue between two dates to analyze customer wait times.
  • Filtering and sorting callback data to identify peak callback periods.
  • Exporting callback data for integration with external reporting tools.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue for which to download callback reports. Usage: queueDnStr={value}
Start Dt The start date/time for the report period. Usage: startDt={value}
End Dt The end date/time for the report period. Usage: endDt={value}
Options Additional query options to refine the data retrieval:
- Top Show only the first n items
- Skip Skip the first n items
- Search Search items by search phrases (supports phrase quoting)
- 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 downloaded queue callback reports. The structure typically includes an array of callback records, each containing details such as callback identifiers, timestamps, queue information, and other relevant metadata depending on the selected properties.

If binary data output is supported (not explicitly shown in the provided code), it would represent downloadable files or attachments related to the queue 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 uses HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect date formats for Start Dt or End Dt may result in errors or empty responses.
    • Using unsupported filter or search syntax can lead to query errors.
    • Network connectivity problems to the 3CX server will prevent data retrieval.

  • Error messages:

    • Authentication errors: Verify that the API key credential is correctly set up and has necessary permissions.
    • Validation errors on input parameters: Ensure date strings and queue identifiers are correctly formatted.
    • API response errors: Check the 3CX server status and network connection.

Links and References

Discussion