3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically providing an operation to list countries. It is useful for scenarios where you need to retrieve country data from the 3CX system, such as populating dropdowns, filtering call routing rules by country, or integrating country information into communication workflows.

For example, you might use this node to fetch a list of countries supported by your telephony system and then use that data to configure call handling based on geographic location.

Properties

Name Meaning
Options A collection of query parameters to customize the listing of countries:
$top Show only the first n items
$skip Skip the first n items
$search Search items by search phrases. If the search phrase contains spaces and is not quoted, it will be automatically quoted.
$filter Filter items by property values (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 (e.g., Id,Name)
$expand Expand related entities (e.g., RelatedEntity1,RelatedEntity2)

These options allow fine-grained control over the query sent to the 3CX API to retrieve country data.

Output

The node outputs JSON data representing the list of countries retrieved from the 3CX system. The structure typically includes an array of country objects with properties depending on the $select option or default fields provided by the API.

If the $count option is enabled, the output may also include metadata about the total number of items available.

No binary data output is expected from this node.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node expects a base URL for the 3CX server, configured in the credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure the API key credential is correctly configured and has sufficient permissions.
  • Invalid query parameters: Incorrect syntax in filter, orderby, or other query options can cause API errors. Validate these strings carefully.
  • Empty results: Check if filters or search terms are too restrictive.
  • Network issues: Verify connectivity to the 3CX server URL.

Links and References

Discussion