3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing functionality to list DID (Direct Inward Dialing) numbers. This operation is useful for retrieving a filtered, sorted, and paginated list of DID numbers configured in the 3CX system. Typical use cases include managing telephony resources, auditing available phone numbers, or integrating DID number data into other workflows such as CRM or call routing systems.

Properties

Name Meaning
Options A collection of query parameters to customize the listing of DID numbers:
$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 wrapped in quotes automatically.
$filter Filter items by property values using OData filter syntax (e.g., State eq 'Connected').
$count Include count of items in the response (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).

Output

The output JSON contains an array of DID number objects retrieved from the 3CX system according to the specified query options. Each object represents a DID number with its associated properties as requested via $select or default fields. The node does not explicitly handle binary data output.

Dependencies

  • Requires connection to a 3CX telephony system API.
  • Needs an API authentication token credential configured in n8n (OAuth2-based).
  • The base URL for the 3CX API must be provided in the credentials configuration.
  • The node sends HTTP requests with JSON headers and expects JSON responses.

Troubleshooting

  • Authentication errors: Ensure the API authentication token is valid and has sufficient permissions to access DID numbers.
  • Invalid query parameters: Incorrect OData filter, orderby, or select syntax may cause API errors. Validate these strings carefully.
  • Empty results: Check if filters or search terms are too restrictive or if the 3CX system actually has DID numbers configured.
  • Network issues: Verify connectivity to the 3CX server URL and that the URL is correctly set without trailing slashes.

Links and References

Discussion