3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node allows updating network settings in a 3CX telephony system. It is useful for administrators who need to programmatically configure or modify network-related parameters such as SIP ports, firewall keep-alive settings, STUN server details, and public IP configurations. Practical applications include automating network configuration changes during deployment, integrating with infrastructure management workflows, or dynamically adjusting network parameters based on environment changes.

Properties

Name Meaning
Allow Source As Outbound Boolean flag to allow source addresses as outbound connections.
Direct SIP Allow External Boolean flag to permit direct SIP connections from external sources.
Direct SIP Local Domain String specifying the local domain used for direct SIP connections.
Firewall Keep Alive Boolean flag to enable or disable firewall keep-alive packets.
Firewall Keep Alive Interval Number defining the interval (in seconds) between firewall keep-alive packets.
Id String identifier for the network settings object to update.
Ip V 6 Binding Enabled Boolean flag to enable or disable IPv6 binding.
Pbx Public FQDN String representing the fully qualified domain name of the PBX public interface.
Public Interface String specifying the public network interface name.
Public Static IP String containing the public static IP address.
Sip Port Number indicating the SIP port to be used.
Stun Disabled Boolean flag to enable or disable STUN functionality.
Stun Primary Host String specifying the primary STUN server hostname.
Stun Primary Port Number indicating the port of the primary STUN server.
Stun Query Number representing the STUN query count or timeout setting.
Stun Secondary Host String specifying the secondary STUN server hostname.
Stun Secondary Port Number indicating the port of the secondary STUN server.
Stun Third Host String specifying the tertiary STUN server hostname.
Stun Third Port Number indicating the port of the tertiary STUN server.
Tunnel Port Number specifying the port used for tunneling.

Output

The node outputs JSON data reflecting the updated network settings after the operation completes. This typically includes confirmation of the applied settings or the current state of the network configuration. The output does not explicitly mention binary data, so it is assumed to be purely JSON structured.

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 uses HTTP requests with JSON payloads to interact with the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Common Issues:
    • Incorrect or missing API authentication token can cause authorization failures.
    • Invalid or incomplete network settings parameters may result in API errors.
    • Network connectivity issues to the 3CX server will prevent updates.
  • Error Messages:
    • Authorization errors indicate problems with the provided API key or credentials.
    • Validation errors from the API suggest incorrect property values; verify types and required fields.
    • Timeout or connection errors imply network or server availability problems; check server URL and network access.

Links and References

Discussion