3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve SLA (Service Level Agreement) statistical report data. Specifically, the "Get Statistic Sla Data" operation under the "Report Statistic Sla" resource fetches detailed SLA metrics for a specified queue within a given time range. This is useful for call center managers or administrators who want to monitor and analyze SLA compliance, wait times, and other performance indicators related to their telephony queues.

Practical examples include:

  • Extracting SLA statistics for a specific call queue over the last week to evaluate service quality.
  • Monitoring wait intervals and response times during peak hours.
  • Filtering and sorting SLA data to identify trends or issues in customer support responsiveness.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue for which SLA statistics are requested. Usage: queueDnStr={queueDnStr}
Start Dt The start date/time for the SLA data query. Usage: startDt={startDt}
End Dt The end date/time for the SLA data query. Usage: endDt={endDt}
Wait Interval The wait interval parameter for the SLA data query. Usage: waitInterval={waitInterval}
Options Additional optional query parameters to refine the request:
- 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 containing the SLA statistics retrieved from the 3CX API based on the input parameters. The structure typically includes an array of SLA records with details such as queue identifiers, timestamps, wait intervals, and other SLA-related metrics.

If binary data were involved (not indicated here), it would represent files or media related to the SLA reports, but this node focuses on JSON data output.

Dependencies

  • Requires an active connection to a 3CX telephony system via its API.
  • Needs an API authentication token or OAuth2 credential configured in n8n to authorize requests.
  • The base URL for the 3CX API must be set correctly in the credentials configuration.
  • The node uses standard HTTP headers accepting JSON responses.

Troubleshooting

  • Common Issues:

    • Incorrect or missing queue identifier (queueDnStr) will result in no data or errors.
    • Invalid date formats for startDt or endDt may cause the API to reject the request.
    • Insufficient permissions or expired API tokens can lead to authentication errors.
    • Overly restrictive filters or search queries might return empty results.

  • Error Messages:

    • Authentication failures: Check that the API key or OAuth2 token is valid and has not expired.
    • Validation errors: Ensure all required fields (queueDnStr, startDt, endDt, waitInterval) are provided and correctly formatted.
    • API connectivity issues: Verify network access to the 3CX server URL and that the URL is correctly configured without trailing slashes.

Links and References

Discussion