3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically allowing users to update phone book settings within 3CX. It is useful for administrators or automation workflows that need to programmatically modify how the phone book behaves in the 3CX system, such as changing display formats, resolving rules, or managing how new entries are added to the phone book queue.

Practical examples include:

  • Automatically updating phone book display preferences across multiple 3CX instances.
  • Adjusting the resolving behavior to improve caller identification based on custom matching rules.
  • Managing how new contacts are appended or prepended to the phone book add queue during bulk imports or synchronization tasks.

Properties

Name Meaning
Phone Book Add Queue Name Determines how new entries are added to the phone book queue. Options: Not Add, Append, Prepend
Phone Book Display Sets the display format of names in the phone book. Options: First Name Last Name, Last Name First Name
Resolving Length Numeric value specifying the length used in resolving matches (used when "Match Length" resolving type is selected)
Resolving Type Defines the method used to resolve phone book entries. Options: Not Resolve, Match Exact, Match Length

Output

The node outputs JSON data representing the result of the update operation on the phone book settings. This typically includes confirmation of the updated settings or any error messages returned by the 3CX API. There is no indication that binary data is output by this node.

Dependencies

  • Requires an API key credential for authenticating with the 3CX system.
  • The node expects a base URL for the 3CX server, which must be configured in the credentials.
  • The node sends requests to the 3CX REST API endpoint /xapi/v1.
  • Proper network access and permissions to the 3CX API are necessary.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid property values (e.g., unsupported resolving types or negative resolving lengths) may lead to API errors.
    • Network connectivity problems to the 3CX server can prevent successful updates.

  • Error messages:

    • Authentication errors usually indicate invalid or expired API tokens; reconfigure credentials.
    • Validation errors from the API suggest incorrect input values; verify property selections and numeric inputs.
    • Timeout or connection errors imply network issues; check server availability and firewall settings.

Links and References

Discussion