3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download SLA breach reports for specified queues within a given time range. It is useful for monitoring and analyzing service level agreement (SLA) breaches in call queues, helping contact center managers or administrators track performance issues and improve customer service.

Typical use cases include:

  • Downloading detailed SLA breach data for specific call queues over a defined period.
  • Automating SLA reporting workflows by fetching breach data programmatically.
  • Filtering and sorting breach records based on various criteria to focus on relevant incidents.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue for which SLA breach data is requested.
Start Dt The start date/time for the report period (inclusive).
End Dt The end date/time for the report period (inclusive).
Wait Interval The interval duration to wait between polling attempts or processing steps.
Client Time Zone The client's time zone to correctly interpret date/time values in the report.
Options Additional query options to customize the data retrieval:
- Top Show only the first n items.
- Skip Skip the first n items.
- Search Search items by search phrases. Supports automatic quoting if needed.
- 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 downloaded SLA breach report entries matching the input parameters and filters. Each item corresponds to an SLA breach record with properties as returned by the 3CX API.

If binary data output is supported (not explicitly shown in the provided code), it would typically represent downloadable report files or attachments related to the breaches.

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.
  • Proper network access to the 3CX server is necessary.

Troubleshooting

  • Invalid Credentials: Ensure the API key or OAuth2 token is valid and has sufficient permissions.
  • Incorrect Date Formats: Verify that Start Dt and End Dt are in the expected format and logical order.
  • Empty Results: Check filter and search parameters; overly restrictive queries may return no data.
  • Timeouts or Delays: Adjust the Wait Interval property if the node times out waiting for data.
  • API Endpoint Issues: Confirm the 3CX server URL is correct and reachable from n8n.

Links and References

Discussion