3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing functionality to download reports of failed callbacks from a queue. It is useful in scenarios where users need to audit or analyze callback failures within their call queues over a specified time range. For example, a contact center manager might use this node to retrieve detailed records of all failed callback attempts for a particular queue during a business day to identify issues or improve customer service.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue for which to download failed callback reports.
Start Dt The start date/time defining the beginning of the report period (usage: startDt={startDt}).
End Dt The end date/time defining the end of the report period (usage: endDt={endDt}).
Client Time Zone The client's time zone to correctly interpret date/time values (usage: clientTimeZone={value}).
Options Additional query options to refine the report data:
- 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 (e.g., "RelatedEntity1,RelatedEntity2").

Output

The node outputs JSON data representing the downloaded report of failed callbacks from the specified queue within the given date range and according to any additional filtering or selection options provided. The structure typically includes details about each failed callback event such as timestamps, queue identifiers, callback status, and possibly related metadata depending on the selected fields.

If binary data output is supported (not explicitly shown in the provided code), it would likely represent downloadable report files (e.g., CSV or Excel) containing the failed callback 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 uses HTTP requests with JSON headers to communicate with the 3CX API endpoint /xapi/v1.
  • No other external dependencies are indicated.

Troubleshooting

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid date formats for Start Dt or End Dt may result in errors or empty results.
    • Providing invalid filter or query options could lead to API errors.
    • Network connectivity issues to the 3CX server can prevent data retrieval.

  • Error Messages:

    • Authentication errors usually indicate invalid or expired API tokens; re-authenticate or update credentials.
    • Validation errors on date/time parameters suggest checking the format and correctness of input values.
    • API response errors related to query parameters imply reviewing the syntax and allowed values for filters, search, and ordering.

Links and References

Discussion