3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing an operation to retrieve the current state of the firewall. This can be useful in scenarios where you need to monitor or audit the firewall status of your 3CX system programmatically. For example, you might use this node to check if the firewall is connected or to gather detailed firewall configuration data as part of a larger automation workflow that manages telephony infrastructure health.

Properties

Name Meaning
Options A collection of query parameters to customize the request for firewall state information:
$top Show only the first n items
$skip Skip the first n items
$search Search items by search phrases (supports phrase quoting automatically)
$filter Filter items by property values (e.g., State eq 'Connected')
$count Include count of items (boolean)
$orderby Order items by property values (e.g., Name desc, CreatedAt asc)
$select Select specific properties to be returned (e.g., Id,Name)
$expand Expand related entities (e.g., RelatedEntity1,RelatedEntity2)

These options allow fine-grained control over the data retrieved from the firewall state endpoint, enabling filtering, sorting, pagination, and selection of specific fields or related entities.

Output

The node outputs JSON data representing the firewall state information retrieved from the 3CX API. The structure of the JSON depends on the query parameters used but generally includes details about firewall connections, statuses, and related metadata.

If binary data were involved, it would typically represent files or media, but in this case, the output is purely JSON reflecting firewall state details.

Dependencies

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

Troubleshooting

  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions to access firewall state information.
  • Invalid query parameters: Incorrect filter, search, or select syntax may cause API errors. Validate OData-style queries before use.
  • Network issues: Verify connectivity to the 3CX server URL and that the server is reachable.
  • Empty results: If no firewall state data is returned, check if the filters or search terms are too restrictive.

Links and References

Discussion