3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing functionality to list backups. This operation retrieves a collection of backup records from the 3CX system, allowing users to query and filter backups based on various criteria.

Common scenarios where this node is beneficial include:

  • Automating the retrieval of backup information for monitoring or auditing purposes.
  • Integrating backup data into workflows that require backup status or metadata.
  • Filtering and sorting backups to find specific ones based on date, name, or other properties.

For example, a user might want to list only the most recent 5 backups or search for backups containing a specific keyword in their description.

Properties

Name Meaning
Options A collection of optional query parameters to customize the listing of backups:
$top Show only the first n items (limit the number of backups returned).
$skip Skip the first n items (useful 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 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.

Output

The output of the node is JSON data representing the list of backups retrieved from the 3CX system. Each item in the output array corresponds to a backup record, including properties as specified by the $select option or all properties by default.

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

The node does not output binary data.

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 credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1/backups (implied by the resource and operation context).

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 options can cause API errors. Validate expressions against 3CX API documentation.
  • Empty results: Check if filters or search terms are too restrictive.
  • Network issues: Verify connectivity to the 3CX server URL.

Links and References

Discussion