3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download detailed queue statistics reports. It is useful for users who want to retrieve historical or real-time data about call queues, such as call volumes, wait times, and agent performance within specific time frames. Practical applications include monitoring call center efficiency, generating performance reports, and integrating queue statistics into dashboards or analytics platforms.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue for which detailed statistics are requested.
Start Dt The start date/time for the statistics report (defines the beginning of the reporting period).
End Dt The end date/time for the statistics report (defines the end of the reporting period).
Wait Interval The interval duration used to segment the waiting time data 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.
- 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 detailed queue statistics for the specified queue and time range. This data typically includes metrics such as call counts, wait times, agent statuses, and other relevant queue performance indicators. The output structure corresponds to the API response from the 3CX system's detailed queue statistics endpoint.

If binary data is included (not indicated explicitly here), it would represent downloadable report files or attachments related to the queue statistics.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in the credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1 with appropriate headers and query parameters.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid date formats for Start Dt or End Dt may result in errors or empty responses.
    • Specifying a non-existent queue identifier (Queue Dn Str) will lead to no data or error messages.
    • Improper use of query options (e.g., malformed filter strings) can cause request failures.

  • Error messages:

    • Authentication errors: Verify that the API key and server URL are correctly set.
    • Validation errors on dates or parameters: Ensure date strings follow the expected format and required fields are filled.
    • API limit or quota exceeded: Check usage limits on the 3CX API and adjust request frequency accordingly.

Links and References

Discussion