3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system to retrieve SLA breach report data. Specifically, the "Get Breaches Sla Data" operation under the "Report Breaches Sla" resource fetches detailed information about SLA breaches within a specified queue and time range. This is useful for monitoring call center performance, identifying SLA violations, and generating reports on service quality.

Practical examples include:

  • Retrieving SLA breach data for a specific call queue over a given date range to analyze agent performance.
  • Filtering and sorting breach records to focus on critical incidents or specific time frames.
  • Using search and filter options to narrow down results based on custom criteria.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue to query SLA breach data for.
Start Dt The start date/time for the SLA breach data retrieval period.
End Dt The end date/time for the SLA breach data retrieval period.
Wait Interval The wait interval parameter used in the request (likely controls polling or timeout behavior).
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 phrase quoting automatically 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 SLA breach records retrieved from the 3CX API. Each item corresponds to an individual breach record containing details such as timestamps, queue identifiers, and SLA status. The exact structure depends on the API response but typically includes fields relevant to SLA breach reporting.

If binary data were involved, it would represent attachments or media related to the breaches, but this node focuses on JSON data output.

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.
  • No additional external dependencies beyond the 3CX API and proper credential setup.

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.
    • Providing invalid filter or search syntax can lead to query errors.
    • Network connectivity problems to the 3CX server will prevent data retrieval.

  • Error messages:

    • Authentication errors indicate issues with the provided API key or OAuth token.
    • Validation errors often relate to required parameters missing or malformed.
    • Timeout or connection errors suggest network or server availability problems.

  • Resolutions:

    • Verify and update API credentials.
    • Ensure date strings are correctly formatted according to API expectations.
    • Review and correct any filter or search expressions.
    • Check network access and server status.

Links and References

Discussion