3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the "Network Settings" resource to retrieve information about network interfaces ("Ifaces"). Specifically, the "Get Ifaces" operation fetches a list of network interfaces with optional query parameters to control pagination, filtering, and searching. This node is useful in scenarios where you need to programmatically access or monitor network interface details from a system or service that exposes such data via an API.

Practical examples include:

  • Retrieving the first 10 active network interfaces.
  • Searching for interfaces by name or status.
  • Filtering interfaces based on connection state (e.g., only connected interfaces).
  • Counting the total number of interfaces matching certain criteria.

Properties

Name Meaning
Options A collection of optional query parameters to refine the request:
- Top: Show only the first n items (pagination limit).
- Skip: Skip the first n items (pagination offset).
- Search: Search items by search phrases; supports phrase quoting automatically.
- Filter: Filter items by property values using expressions (e.g., State eq 'Connected').
- Count: Boolean flag to include the count of items in the response.

Output

The output JSON contains the list of network interfaces retrieved according to the specified options. Each item typically represents a network interface with its properties such as name, state, and other relevant attributes depending on the underlying API.

If the "Count" option is enabled, the output may also include the total count of matching interfaces.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authentication to the target system exposing the network settings API.
  • The base URL for the API is configured dynamically from credentials.
  • The node sends HTTP requests with JSON accept headers.

Troubleshooting

  • Empty results: Check if the filter or search parameters are too restrictive or incorrectly formatted.
  • Authentication errors: Ensure the API key or authentication token is valid and has sufficient permissions.
  • Invalid query parameters: Verify that the $top, $skip, $search, and $filter values conform to the expected syntax of the API.
  • Network issues: Confirm connectivity to the API endpoint and correct base URL configuration.

Links and References

Discussion