3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node operation updates the general settings for applications within the 3CX telephony system. It allows users to configure various application-wide preferences such as password change permissions, UI avatar style, branding images and URLs, chat enablement, and visibility of certain features or data (e.g., CRM contacts, interaction history). This is useful for administrators who want to customize the behavior and appearance of their 3CX apps to fit organizational policies or branding guidelines.

Practical examples include:

  • Disabling password changes for users to enforce centralized credential management.
  • Setting a circular avatar style for user profiles in the app interface.
  • Uploading custom brand logos and main images to reflect company identity.
  • Enabling or disabling chat functionality based on communication needs.
  • Hiding sensitive data like CRM contacts or interaction history from certain users.

Properties

Name Meaning
Allow Change Password Boolean flag to allow or disallow users to change their passwords.
Auto Scheduler Settings JSON object defining automatic scheduling configurations for the app.
Avatar Style Choice between "Square" or "Circle" avatar shapes for user profile pictures.
Brand Logo Image URL or identifier string for the brand logo image displayed in the app.
Brand Main Image URL or identifier string for the main brand image used in the app interface.
Brand Url URL string linking to the brand's website or landing page.
Enable Chat Boolean flag to enable or disable chat functionality within the app.
Hide Abandoned Queue Calls Boolean flag to hide or show abandoned queue calls in call logs or reports.
Hide CRM Contacts Boolean flag to hide or show CRM contact information within the app.
Hide Interaction History Boolean flag to hide or show user interaction history records.
Hide System Extensions Boolean flag to hide or show system extensions in the app interface.
Name Of Custom Available Status String to define a custom label for the "Available" user status.
Name Of Custom Out Of Office Status String to define a custom label for the "Out of Office" user status.

Output

The node outputs JSON data representing the updated general settings for the apps after applying the changes. The structure corresponds to the properties sent in the request body, reflecting the new configuration state.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key or OAuth2 token credential to authenticate 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 to update settings.

Troubleshooting

  • Invalid JSON in Auto Scheduler Settings: Since this property expects a JSON string parsed into an object, malformed JSON will cause errors. Ensure valid JSON syntax.
  • Authentication Errors: If the API key or OAuth2 token is missing or invalid, the node will fail to authenticate. Verify credentials are correctly set up.
  • Invalid Property Values: Providing unsupported values for options like Avatar Style may result in API rejection. Use only allowed options ("Square", "Circle").
  • Network Issues: Connectivity problems to the 3CX server URL will prevent updates. Confirm network access and correct server URL.
  • Empty Required Fields: Some fields might be required by the API even if optional in the node; check API documentation if updates fail.

Links and References

Discussion