3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system to retrieve system status information. Specifically, the "Get System Status" operation fetches details about the current state of the 3CX system, which can be useful for monitoring and managing telephony infrastructure.

Common scenarios include:

  • Monitoring the health and connectivity status of the 3CX system.
  • Retrieving filtered or specific subsets of system status data for dashboards or alerts.
  • Automating responses based on system status changes.

For example, a user might configure this node to get only the first 10 system status items that are currently connected, or search for specific status entries containing certain keywords.

Properties

Name Meaning
$top Show only the first n items (limit the number of results).
$skip Skip the first n items (useful for pagination).
$search Search items by search phrases. If the phrase contains spaces and is not already quoted, it will be automatically quoted.
$filter Filter items by property values using expressions (e.g., State eq 'Connected').
$count Include count of items in the response (boolean).
$orderby Order items by property values (e.g., Name desc, CreatedAt asc).
$select Select specific properties to be returned (comma-separated list, e.g., Id,Name).
$expand Expand related entities (comma-separated list of related entity names).

These options allow fine-grained control over the query parameters sent to the 3CX API when retrieving system status data.

Output

The node outputs JSON data representing the system status information retrieved from the 3CX API. The structure of the JSON depends on the selected query options but generally includes an array of system status items with their properties.

If binary data were involved (not indicated here), it would typically represent files or media; however, this node focuses on JSON data output.

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 credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate query parameters.

Troubleshooting

  • Authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Invalid query parameters: Incorrect filter, orderby, or select syntax may cause API errors. Verify parameter formats against 3CX API documentation.
  • Empty or missing data: Check if filters or search terms are too restrictive or if the system status data exists.
  • Network issues: Confirm network connectivity to the 3CX server URL.

Links and References

Discussion