3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve agent login history data reports. It is useful for monitoring and analyzing agent activity within a call center environment, such as tracking when agents logged in or out, their queue assignments, and overall login patterns over specified time periods.

Practical examples include:

  • Generating reports on agent availability during specific date ranges.
  • Filtering login history by particular queues or agents.
  • Exporting login data for performance analysis or compliance auditing.

Properties

Name Meaning
Client Time Zone The client’s time zone to be used in the query (e.g., "America/New_York").
Start Dt The start date/time for the login history data range (format depends on API requirements).
End Dt The end date/time for the login history data range.
Queue Dn Str A string specifying one or more queue identifiers to filter the login history.
Agent Dn Str A string specifying one or more agent identifiers to filter the login history.
Options Additional optional query parameters:
- Top Limit the number of returned items 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 filter items by property values (e.g., State eq 'Connected').
- Count Boolean flag to include the count of total items matching the query.
- Select Comma-separated list of properties to return (e.g., Id,Name).
- Orderby Comma-separated list of properties to order results by, with direction (e.g., Name desc).
- Expand Comma-separated list of related entities to expand in the response.

Output

The node outputs JSON data representing the agent login history records retrieved from the 3CX system. Each item typically contains details about agent login sessions, including timestamps, agent identifiers, queue information, and status.

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

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in credentials.
  • Uses OAuth2 authentication for secure API access.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid date formats for Start Dt or End Dt may lead to errors or empty results.
    • Providing invalid filter or search syntax can cause the API to reject the request.
    • Network connectivity problems to the 3CX server will prevent data retrieval.

  • Error messages:

    • Authentication errors usually indicate invalid or expired tokens; re-authenticate or update credentials.
    • Validation errors on input parameters suggest checking the format and required fields.
    • API rate limiting or server errors require retrying after some time or contacting the 3CX administrator.

Links and References

Discussion