3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node is designed to update a parameter entity within the 3CX telephony system via its API. It allows users to modify existing parameters by specifying their unique identifier and updating fields such as Description, Name, and Value. This node is useful in scenarios where dynamic configuration or adjustment of telephony parameters is required, for example, changing call routing settings, updating user preferences, or modifying system variables programmatically.

Properties

Name Meaning
Id The unique identifier of the parameter entity to update. Can be set using an expression like {{$json.Id}}. This is required.
Description A textual description of the parameter. Optional field to provide additional context or details about the parameter.
Name The name of the parameter. Used to identify or label the parameter within the system.
Value The value assigned to the parameter. Represents the actual data or setting to be updated.

Output

The node outputs JSON data representing the response from the 3CX API after attempting to update the parameter. This typically includes confirmation of the update operation, the updated parameter details, or error information if the update failed. There is no indication that the node outputs binary data.

Dependencies

  • Requires an active connection to the 3CX telephony system API.
  • Needs an API authentication token configured via OAuth2 credentials.
  • The base URL for the API must be provided in the node credentials configuration.
  • The node sends requests with headers accepting JSON responses.

Troubleshooting

  • Common Issues:

    • Invalid or missing parameter Id will cause the update to fail.
    • Incorrect or expired API authentication token may result in authorization errors.
    • Network connectivity issues to the 3CX server can prevent successful API calls.
    • Providing invalid values for fields (e.g., unsupported characters) might cause API validation errors.

  • Error Messages:

    • Authorization errors typically indicate problems with the API key or OAuth2 token; re-authenticate or refresh credentials.
    • "Parameter not found" errors suggest the specified Id does not exist; verify the Id value.
    • Validation errors on fields like Name or Value require checking input formats and constraints.

Links and References

Discussion