3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve general settings for a PBX (Private Branch Exchange). It is useful in scenarios where users need to programmatically access or manage PBX configuration data, such as fetching current system settings, auditing configurations, or integrating PBX data into other workflows.

For example, a user might want to get a list of all general PBX settings filtered by certain criteria or sorted by specific properties to monitor system status or automate reporting.

Properties

Name Meaning
Options A collection of query parameters to customize the data retrieval:
$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 already 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 fetch PBX general settings.

Output

The node outputs JSON data representing the general settings retrieved from the 3CX PBX system. The structure corresponds to the queried properties and expanded related entities as specified in the input options.

If binary data were involved, it would typically represent files or media, but this node focuses on JSON data about PBX settings.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the base URL of the 3CX server configured in credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate query parameters based on user input.

Troubleshooting

  • Common issues:

    • Incorrect or missing API authentication token can cause authorization errors.
    • Invalid query parameters (e.g., malformed $filter or $orderby strings) may result in API errors.
    • Network connectivity problems to the 3CX server will prevent data retrieval.

  • Error messages:

    • Authorization errors usually indicate invalid or expired credentials; re-authenticate or update the API key.
    • Bad request errors suggest incorrect query syntax; verify the formatting of filter, orderby, and search strings.
    • Timeout or connection errors require checking network access and server availability.

Links and References

Discussion