3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download statistics about abandoned chats within specified parameters. It is useful for contact center managers or analysts who want to retrieve detailed reports on abandoned chat sessions filtered by queue, date range, participant type, and client time zone. For example, a user can extract data on how many chats were abandoned in a particular queue during a specific week, helping to identify service issues or staffing needs.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue for which abandoned chat statistics are requested.
Start Dt The start date/time for the report period (format expected as per API requirements).
End Dt The end date/time for the report period.
Participant Type Numeric code representing the type of participant to include in the report (e.g., agent or customer).
Client Time Zone The time zone context for the client requesting the report, affecting date/time interpretation.
Options Additional query options to refine the request:
- Top Limit the number of items returned to the first n entries.
- Skip Skip the first n items in the result set.
- Search Search phrase(s) to filter items by text matching.
- Filter OData-style filter expression to narrow down results by property values.
- Count Boolean flag to include the total count of items in the response.
- Select Comma-separated list of properties to return for each item.
- Orderby Comma-separated list of properties to order the results by, with optional ascending/descending.
- Expand Related entities to expand inline in the response.

Output

The node outputs JSON data containing the abandoned chat statistics matching the input criteria. The structure typically includes an array of records, each representing an abandoned chat session or aggregated statistics depending on the API response. Each record may contain fields such as timestamps, queue identifiers, participant details, and abandonment reasons.

If binary data is returned (not indicated here), it would represent downloadable report files or attachments, but this node primarily deals with JSON responses.

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 standard HTTP and OAuth2 authentication.

Troubleshooting

  • Invalid Date Format: Ensure Start Dt and End Dt are provided in the correct format expected by the 3CX API; otherwise, the request may fail or return no data.
  • Authentication Errors: Verify that the API key or OAuth2 token is valid and has sufficient permissions to access reporting endpoints.
  • Empty Results: If no data is returned, check that the queue identifier and participant type are correct and that the date range actually contains abandoned chat events.
  • Query Option Misuse: Incorrect use of OData filters or search syntax in the Options collection can cause errors or unexpected results. Validate expressions carefully.
  • API Endpoint Issues: Confirm the base URL is correctly set without trailing slashes to avoid malformed requests.

Links and References

Discussion