3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download SLA (Service Level Agreement) statistics reports for a specified queue within a given time range. It is useful for monitoring and analyzing call center performance, such as tracking how well service levels are met over time.

Typical use cases include:

  • Downloading SLA statistics for a specific queue to evaluate customer service efficiency.
  • Generating reports for management on call handling times and SLA compliance.
  • Integrating SLA data into dashboards or further processing workflows.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue for which SLA statistics are requested.
Start Dt The start date/time for the SLA statistics report period.
End Dt The end date/time for the SLA statistics report period.
Wait Interval The interval duration used for waiting or polling during the download process.
Options Additional query options to customize the request:
- Top Show only the first n items in the result.
- Skip Skip the first n items in the result.
- Search Search items by phrases; supports quoted phrases for exact matches.
- Filter Filter items by property values (e.g., "State eq 'Connected'").
- Count Include count of items in the response (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 in the response (comma-separated list).

Output

The node outputs JSON data containing the downloaded SLA statistics report for the specified queue and time range. The structure typically includes statistical metrics relevant to SLA performance, such as counts, durations, and status indicators.

If binary data is included (not explicitly shown in the provided code), it would represent downloadable report files or raw data exports.

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

  • 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 valid date/time strings accepted by the 3CX API.
  • Queue identifier errors: Verify that the Queue Dn Str corresponds to an existing queue in the 3CX system.
  • API rate limits or connectivity issues: Network problems or API throttling may cause failures; check network access and retry policies.
  • Incorrect query options: Improperly formatted filter, search, or orderby parameters can lead to API errors; validate these inputs carefully.

Links and References

Discussion