3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node operation, Set Dir Search Settings under the Contacts resource, allows users to configure directory search settings for a 3CX telephony system. It is useful when you want to customize how the 3CX system searches and accesses contact directories, including specifying Exchange email addresses, folders, and passwords related to directory synchronization or lookup.

Practical examples include:

  • Setting up which Exchange email accounts the 3CX system should query for contacts.
  • Defining specific Exchange folders to be included in directory searches.
  • Providing necessary authentication details (passwords) for accessing Exchange services securely.

Properties

Name Meaning
Dir Search Settings A JSON object containing configuration for directory search, including:
- ExchangeEmailAddresses: An array of email addresses used by Exchange for searching.
- ExchangeFolders: An array of folder names within Exchange to search contacts.
- ExchangePassword: Authentication credentials/passwords required for Exchange access.

The property expects a JSON structure similar to:

{
  "ExchangeEmailAddresses": [null],
  "ExchangeFolders": [null],
  "ExchangePassword": {}
}

Users should replace null and empty objects with actual values as needed.

Output

The node outputs data in JSON format reflecting the result of setting the directory search settings on the 3CX system. The exact structure depends on the API response from the 3CX server but generally includes confirmation of updated settings or error information if the update failed.

No binary data output is expected from this operation.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token or OAuth2 credential configured in n8n to authorize requests to the 3CX API.
  • The base URL of the 3CX server must be provided in the credentials configuration.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Invalid JSON in Dir Search Settings: If the JSON input is malformed, the node will fail to parse it. Ensure the JSON is valid before running.
  • Authentication Errors: If the API key or OAuth2 token is missing or invalid, the node will return authorization errors. Verify credentials are correctly set up.
  • Connection Issues: Network problems or incorrect server URLs can cause request failures. Confirm the 3CX server URL is correct and reachable.
  • API Response Errors: If the 3CX API rejects the settings due to invalid parameters, check that all required fields in the directory search settings are properly filled and formatted.

Links and References

Discussion