3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to list blacklisted phone numbers. It is useful for scenarios where users want to retrieve and manage a list of phone numbers that have been blocked or blacklisted in their 3CX system. For example, a user might want to audit which numbers are currently blacklisted or integrate this data into a larger workflow for call management or reporting.

Properties

Name Meaning
Options A collection of optional query parameters to customize the listing of blacklisted numbers:
$top Show only the first n items (limit the number of results returned).
$skip Skip the first n items (useful for pagination).
$search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be automatically quoted.
$filter Filter items by property values (e.g., filter by state or other properties).
$count Include count of items (boolean to include total count in response).
$orderby Order items by property values (e.g., "Name desc, CreatedAt asc").
$select Select specific properties to be returned (e.g., "Id,Name").
$expand Expand related entities (include related data from linked entities).

Output

The node outputs JSON data representing the list of blacklisted numbers retrieved from the 3CX system. The structure typically includes an array of blacklisted number objects, each containing properties such as the phone number, status, and any metadata depending on the selected fields.

If binary data were involved (not indicated here), it would represent associated files or media, but this node focuses on JSON data output.

Dependencies

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

Troubleshooting

  • Authentication errors: Ensure that the API credentials (OAuth2 token) are correctly set up and valid.
  • Invalid query parameters: Incorrect formatting in options like $filter, $orderby, or $search may cause API errors. Verify syntax according to 3CX API documentation.
  • Empty results: Check if the blacklist actually contains entries or if filters/search terms are too restrictive.
  • Network issues: Confirm that the 3CX server URL is reachable from the n8n instance.

Links and References

Note: This summary is based on static analysis of the node's properties and bundled source code without runtime execution.

Discussion