3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing an operation to retrieve the monitor status of users. It is useful in scenarios where you need to programmatically check the current status or presence information of users within a 3CX environment, such as monitoring call center agents' availability or tracking user connection states.

For example, a contact center manager could use this node to fetch real-time statuses of all agents to dynamically route calls or generate reports on agent activity.

Properties

Name Meaning
Options A collection of optional query parameters to customize the request:
- Top Show only the first n items (limit the number of returned results).
- Skip Skip the first n items (useful for pagination).
- Search Search items by search phrases; supports automatic quoting if the phrase contains spaces.
- Filter Filter items by property values using OData-like syntax (e.g., State eq 'Connected').
- Count Include count of items in the response (boolean).

Output

The node outputs JSON data representing the monitor status of users retrieved from the 3CX system. The structure typically includes user details and their current status information. If the "Count" option is enabled, the output will also include the total count of matching items.

No binary data output is indicated.

Dependencies

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

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid filter or search syntax may result in errors or empty responses.
    • Network connectivity problems to the 3CX server can cause timeouts or connection errors.

  • Error messages:

    • Authentication errors usually indicate invalid or expired API tokens; re-authenticate or update credentials.
    • Query parameter errors suggest malformed $filter or $search strings; verify syntax according to 3CX API documentation.
    • Server not reachable errors require checking the server URL and network access.

Links and References

Discussion