3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically to retrieve phone book settings. The "Get Phone Book Settings" operation allows users to query and fetch phone book configuration data from 3CX. This is useful in scenarios where you want to integrate or synchronize contact information stored in 3CX with other systems, automate management of phone book entries, or display phone book settings within workflows.

Practical examples include:

  • Automatically fetching updated phone book settings to sync with a CRM.
  • Filtering phone book entries based on certain criteria for reporting.
  • Retrieving only specific fields of phone book settings to optimize data usage.

Properties

Name Meaning
Options A collection of optional query parameters to customize the request:
$top Show only the first n items (limit the number of results).
$skip Skip the first n items (offset for pagination).
$search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be quoted automatically.
$filter Filter items by property values using OData filter syntax (e.g., State eq 'Connected').
$count Include count of items (boolean).
$orderby Order items by property values (e.g., Name desc, CreatedAt asc).
$select Select specific properties to be returned (comma-separated list, e.g., Id,Name).
$expand Expand related entities (comma-separated list of related entity names).

These options allow fine-grained control over the data retrieved from the phone book settings endpoint.

Output

The node outputs JSON data representing the phone book settings retrieved from the 3CX API. The structure corresponds to the queried phone book settings, potentially including multiple entries depending on the query parameters used.

If binary data were involved (not indicated here), it would represent files or attachments related to phone book settings, but this node focuses on JSON data output.

Dependencies

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

Troubleshooting

  • Authentication errors: Ensure that the API authentication token is valid and has sufficient permissions to access phone book settings.
  • Invalid query parameters: Using incorrect OData syntax in $filter, $orderby, or other options may cause API errors. Validate these expressions carefully.
  • Empty responses: If no phone book settings are returned, verify that the 3CX system actually has phone book data and that filters/search terms are correct.
  • Network issues: Confirm that the server URL is reachable from the n8n instance and that there are no firewall restrictions.

Links and References

Discussion