3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download agent login history reports. It is useful for administrators or managers who want to analyze agent activity within specific time frames, queues, and agents. For example, a call center manager can use this node to retrieve login/logout times of agents to monitor attendance or performance.

Properties

Name Meaning
Client Time Zone The client’s time zone to be used in the report (e.g., "America/New_York").
Start Dt The start date/time for the login history report (format as required by the API).
End Dt The end date/time for the login history report (format as required by the API).
Queue Dn Str A string identifying the queue(s) to filter the report by.
Agent Dn Str A string identifying the agent(s) to filter the report by.
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 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 (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 containing the agent login history report matching the specified filters and options. The structure typically includes details such as agent identifiers, login/logout timestamps, queue information, and possibly status or state fields depending on the API response. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the node credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1 with appropriate headers.

Troubleshooting

  • Common issues:
    • Incorrect date/time format for Start Dt or End Dt may cause API errors.
    • Invalid or missing API credentials will result in authentication failures.
    • Providing invalid queue or agent strings may return empty results or errors.
  • Error messages:
    • Authentication errors indicate problems with the API key or OAuth token; verify credentials.
    • Validation errors usually relate to missing required parameters or incorrect formats; ensure all required fields are filled correctly.
    • Network or timeout errors suggest connectivity issues with the 3CX server; check network settings and server availability.

Links and References

Discussion