3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically allowing users to update tenant properties within that system. This operation is useful for managing configuration or metadata associated with tenants in 3CX, such as updating property names, descriptions, or values dynamically.

Common scenarios include:

  • Automating updates to tenant settings based on external triggers.
  • Synchronizing tenant property data from other systems.
  • Managing tenant metadata programmatically without manual intervention.

For example, a user might update a tenant property "SupportLevel" to reflect a new service tier or change a description to clarify the property's purpose.

Properties

Name Meaning
Name The key (name) of the tenant property to update. Supports expressions like {{$json.Name}}.
Description A textual description of the tenant property.
Value The value to assign to the tenant property.

Output

The node outputs JSON data representing the response from the 3CX API after updating the tenant property. This typically includes confirmation of the updated property details or any error messages returned by the API.

If the node supports binary data output, it would relate to any file or media content returned by the 3CX API, but this is not indicated in the provided code or properties.

Dependencies

  • Requires an API authentication token credential to connect securely to the 3CX 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

  • Invalid Credentials: If the API key or OAuth token is incorrect or expired, the node will fail to authenticate. Ensure valid credentials are provided.
  • Incorrect Property Name: Updating a non-existent tenant property may result in an error. Verify the property name exists before updating.
  • Network Issues: Connectivity problems to the 3CX server can cause request failures. Check network access and server availability.
  • API Errors: The 3CX API may return errors if the request body is malformed or missing required fields. Confirm all required properties (Name, Value) are correctly set.

Links and References

Discussion