3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically to retrieve dial code settings. The "Get Dial Code Settings" operation fetches a list of dial code configurations from the 3CX API, allowing users to query and filter these settings based on various criteria.

This node is useful in scenarios where you need to programmatically access or audit dial code configurations within a 3CX phone system, such as integrating telephony settings into a CRM, monitoring changes, or automating configuration reports.

Example use cases:

  • Retrieve all dial code settings with pagination.
  • Search for dial codes matching specific phrases.
  • Filter dial codes by state or other properties.
  • Select only certain fields to reduce payload size.
  • Expand related entities to get detailed linked information.

Properties

Name Meaning
Options A collection of optional query parameters to customize the retrieval of dial code settings:
$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 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).
$expand Expand related entities to include additional linked data (comma-separated list).

Output

The node outputs JSON data representing the dial code settings retrieved from the 3CX API. The structure corresponds to the queried dial code entities, including any selected or expanded properties.

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

No binary data output is indicated for this operation.

Dependencies

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

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is valid and has sufficient permissions to access dial code settings.
  • Invalid query parameters: Incorrect OData filter or orderby syntax can cause API errors. Validate expressions carefully.
  • Empty results: Check if filters or search terms are too restrictive or incorrectly formatted.
  • Network issues: Verify connectivity to the 3CX server URL and that the URL is correctly set without trailing slashes.
  • API version mismatch: Confirm that the 3CX API version matches the expected /xapi/v1 endpoint.

Links and References

Discussion