3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically allowing updates to SBC (Session Border Controller) entities within the system. It is useful for automating management tasks such as updating configuration details of SBCs, including network settings, authentication credentials, and identification parameters.

Typical use cases include:

  • Updating an SBC's display name or group assignment.
  • Changing network-related properties like local or public IP addresses.
  • Modifying connection status or provisioning links.
  • Managing phone-related identifiers such as MAC address or user ID.

This node helps streamline telephony infrastructure management by integrating these updates into automated workflows.

Properties

Name Meaning
Name The unique entity key identifying the SBC to update. Supports expressions.
Display Name The human-readable name for the SBC.
Group The group to which the SBC belongs.
Has Connection Boolean indicating whether the SBC currently has a connection.
Local I Pv 4 The local IPv4 address assigned to the SBC.
Password The password associated with the SBC for authentication purposes.
Phone MAC The MAC address of the phone device connected to the SBC.
Phone User Id Numeric identifier for the phone user associated with the SBC.
Provision Link URL or link used for provisioning the SBC.
Public IP The public IP address of the SBC.
Version The version string of the SBC software or firmware.

Output

The node outputs JSON data representing the updated SBC entity after the operation completes. This typically includes all the fields sent in the update request along with any additional metadata returned by the 3CX API confirming the update status.

If binary data were involved (not indicated here), it would represent files or media related to the SBC, but this node focuses on JSON-based configuration data.

Dependencies

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

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Providing an invalid or non-existent SBC Name will result in errors indicating the entity was not found.
    • Network connectivity problems to the 3CX server can cause timeouts or unreachable host errors.
    • Invalid property values (e.g., malformed IP addresses) may be rejected by the API.

  • Error messages:

    • Authentication errors: Verify that the API key and server URL are correctly set.
    • Not found errors: Ensure the Name property matches an existing SBC entity.
    • Validation errors: Check that all input fields conform to expected formats and types.

Links and References

Discussion