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 agents in a specific queue over a defined time period. It is useful for call center managers or administrators who want to analyze agent performance and queue activity by retrieving detailed reports on agents currently in the queue.

Typical use cases include:

  • Monitoring agent availability and workload during specific intervals.
  • Generating historical reports of queue activity for performance analysis.
  • Exporting data for further processing or integration with other systems.

For example, a user can specify a particular queue identifier and a date range to download statistics about how many agents were in that queue, their wait times, and other relevant metrics.

Properties

Name Meaning
Queue Dn Str The identifier string of the queue to retrieve agent statistics from. Usage: queueDnStr={value}
Start Dt The start date/time for the report interval. Usage: startDt={value}
End Dt The end date/time for the report interval. Usage: endDt={value}
Wait Interval The wait interval parameter defining the granularity or segment of waiting times. Usage: waitInterval={value}
Options Additional query options to customize the request:
- Top: Show only the first n items
- Skip: Skip the first n items
- Search: Search items by 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
- Orderby: Order items by property values
- Expand: Expand related entities

Output

The node outputs JSON data containing the downloaded agents-in-queue statistics according to the specified parameters. The structure typically includes details per agent such as identifiers, status, wait times, and other queue-related metrics.

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

Dependencies

  • Requires an API key or OAuth2 authentication credential to connect securely to the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node uses HTTP requests with JSON responses from the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Missing or invalid credentials: Ensure the API key or OAuth2 token is correctly set up and has sufficient permissions.
  • Invalid date formats: The startDt and endDt must be valid date strings accepted by the API.
  • Queue identifier errors: Verify that the queueDnStr corresponds to an existing queue in the 3CX system.
  • API rate limits or connectivity issues: Check network connectivity and API usage limits.
  • Incorrect option parameters: Validate that optional query parameters like $filter, $orderby, etc., are correctly formatted.

Common error messages may include authentication failures, invalid parameter errors, or empty result sets if no data matches the criteria.

Links and References

Discussion