3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve call type settings. Specifically, the "Get Call Types Settings" operation fetches a list of call types configured in the 3CX system, allowing users to query and filter these settings based on various criteria.

Common scenarios where this node is beneficial include:

  • Integrating 3CX call type data into workflows for reporting or analytics.
  • Automating configuration audits by retrieving current call type settings.
  • Filtering call types dynamically based on specific properties for further processing.

For example, a user might want to get only the first 10 call types sorted by name or search for call types containing a particular keyword.

Properties

Name Meaning
Options A collection of optional query parameters to customize the retrieval of call type settings:
$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 expressions (e.g., State eq 'Connected').
$count Include the 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 (e.g., Id,Name).
$expand Expand related entities to include additional linked data (e.g., RelatedEntity1,RelatedEntity2).

Output

The node outputs JSON data representing the retrieved call type settings from the 3CX system. The structure typically includes an array of call type objects, each containing properties as requested via $select or all properties if none specified.

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

No binary data output is expected from this operation.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node uses the base URL provided in the credentials to make REST API calls to the 3CX /xapi/v1 endpoint.
  • Proper network access to the 3CX server is necessary.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token provided in credentials is valid and has sufficient permissions.
  • Network issues: Verify connectivity to the 3CX server URL; check firewall or VPN settings.
  • Invalid query parameters: Incorrect syntax in $filter, $orderby, or other OData-like query options can cause errors. Validate expressions carefully.
  • Empty results: If no call types are returned, try adjusting filters or removing restrictive query options.
  • Unexpected response format: Confirm that the 3CX API version matches expectations and that the base URL is correctly set without trailing slashes.

Links and References

Discussion