3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node operation retrieves country codes from the 3CX telephony system API. It is useful when you need to obtain a list of country codes for purposes such as formatting phone numbers, validating user input, or configuring telephony settings based on geographic regions.

Typical use cases include:

  • Fetching a filtered or paginated list of country codes.
  • Searching for specific country codes by name or other attributes.
  • Selecting only certain properties of country codes to optimize data usage.
  • Expanding related entities linked to country codes for richer information.

Properties

Name Meaning
$top Show only the first n items (pagination limit).
$skip Skip the first n items (pagination offset).
$search Search items by search phrases. If the phrase contains spaces and is not quoted, it will be auto-quoted.
$filter Filter items by property values using OData filter syntax (e.g., State eq 'Connected').
$count Include count of total 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 to include additional linked data (comma-separated list).

These options allow fine-grained control over the query to the country codes endpoint, enabling efficient retrieval tailored to your needs.

Output

The node outputs JSON data containing the list of country codes matching the query parameters. The structure typically includes an array of country code objects with properties such as ID, name, and possibly expanded related entities depending on the $expand parameter.

If the $count option is enabled, the output also includes the total count of items available.

No binary data output is involved in this operation.

Dependencies

  • Requires connection to a 3CX telephony system API endpoint.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The base URL for the API is derived from the provided credentials.
  • The node sends HTTP requests with Accept: application/json header.

Troubleshooting

  • Authentication errors: Ensure that the API authentication token is valid and has sufficient permissions to access country codes.
  • Invalid query parameters: Incorrect syntax in $filter, $orderby, or other OData query options may cause errors. Validate these parameters against the 3CX API documentation.
  • Empty results: If no country codes are returned, check if the $search or $filter criteria are too restrictive.
  • Network issues: Verify connectivity to the 3CX server URL and that the URL is correctly configured without trailing slashes.

Links and References

Discussion