3CX icon

3CX

Interact with 3CX telephony system

Actions462

Overview

The node provides an operation to update a CRM integration configuration within the 3CX telephony system. It allows users to modify various settings related to how the CRM integration behaves, such as enabling it for different call types, setting country information, managing phonebook synchronization, and defining priority options for phonebook queries.

This node is beneficial in scenarios where organizations want to programmatically update their CRM integration settings in 3CX, for example:

  • Enabling or disabling CRM integration for specific call types (DID calls or external calls).
  • Adjusting phonebook synchronization preferences.
  • Changing the priority behavior of phonebook lookups.
  • Updating metadata like the integration name or country.

Practical example: An administrator automates updating multiple CRM integrations after a policy change that requires disabling the integration for external calls but keeping it enabled for DID calls.

Properties

Name Meaning
Country The country associated with the CRM integration.
Enabled For Did Calls Boolean flag to enable or disable the CRM integration for Direct Inward Dialing (DID) calls.
Enabled For External Calls Boolean flag to enable or disable the CRM integration for external calls.
Id The unique identifier of the CRM integration to update.
Name The display name of the CRM integration.
Phonebook Priority Options Defines the priority behavior when querying the phonebook. Options: "Not Query If In Phonebook Found", "Always Query".
Phonebook Synchronization Boolean flag indicating whether phonebook synchronization is enabled.
Possible Values JSON array representing possible values relevant to the CRM integration configuration.
Variable Choices JSON array representing variable choices related to the CRM integration.

Output

The node outputs JSON data reflecting the result of the update operation on the CRM integration. This typically includes confirmation of the updated fields or the full updated CRM integration object as returned by the 3CX API.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node uses the 3CX API endpoint configured via credentials, specifically targeting the /xapi/v1 base URL.
  • Proper network access to the 3CX server is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing CRM integration Id will cause the update to fail.
    • Incorrect API credentials or server URL misconfiguration can lead to authentication errors.
    • Malformed JSON in Possible Values or Variable Choices properties may cause parsing errors.
  • Error messages:

    • Authentication failures usually indicate invalid or expired API tokens; re-authenticate or update credentials.
    • Validation errors from the API may indicate missing required fields or invalid property values; verify input correctness.
    • JSON parsing errors suggest improper formatting in JSON-type properties; ensure valid JSON syntax.

Links and References

Discussion