3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system to retrieve network settings. Specifically, the "Get Network Settings" operation fetches network configuration details from the 3CX system. This is useful for administrators or automation workflows that need to monitor, audit, or adjust network-related parameters of their telephony infrastructure.

Practical examples include:

  • Automatically retrieving current network configurations to verify compliance.
  • Integrating network settings data into monitoring dashboards.
  • Using filters and search options to find specific network settings matching criteria.

Properties

Name Meaning
Options A collection of query parameters to customize the retrieval of network settings:
$top Show only the first n items
$skip Skip the first n items
$search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be auto-quoted.
$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 which network settings are retrieved and how they are presented.

Output

The node outputs JSON data representing the network settings retrieved from the 3CX system. The structure depends on the selected properties and any expansions requested via $select and $expand. Typically, this includes details such as network interfaces, IP addresses, connection states, and other relevant network configuration data.

If binary data were involved (not indicated here), it would represent files or media related to network settings, but this node focuses on JSON data output.

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.

Troubleshooting

  • Authentication errors: Ensure the API key or OAuth token is valid and has sufficient permissions.
  • Invalid query parameters: Incorrect filter, search, or orderby syntax may cause API errors. Validate OData query expressions.
  • Empty results: Check if filters or search terms are too restrictive or if the 3CX server has network settings configured.
  • Connection issues: Verify the 3CX server URL is correct and reachable from the n8n instance.

Links and References

Discussion