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 retrieve failover scripts related to backups. This operation is useful in scenarios where users need to manage or audit failover configurations for their telephony backups, ensuring business continuity and quick recovery in case of system failures.

Practical examples include:

  • Fetching a list of failover scripts to verify backup integrity.
  • Searching or filtering failover scripts based on specific criteria such as state or name.
  • Paginating through large sets of failover scripts using top and skip options.

Properties

Name Meaning
Options A collection of optional query parameters to refine the retrieval of failover scripts:
$top Show only the first n items (pagination limit).
$skip Skip the first n items (pagination offset).
$search Search failover scripts by search phrases. If the phrase contains spaces and is not quoted, it will be automatically quoted.
$filter Filter failover scripts by property values, e.g., State eq 'Connected'.
$count Include the count of items in the response (boolean).

Output

The output JSON field contains an array of failover script objects retrieved from the 3CX system. Each object represents a failover script with its associated properties as returned by the API.

If binary data were involved (not indicated here), it would typically represent downloadable script files or attachments, but this node focuses on JSON data representing failover scripts.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node expects a base URL for the 3CX server, which must be configured in the credentials.
  • The node sends requests to the /xapi/v1 endpoint of the 3CX API.
  • The request headers specify Accept: application/json.

Troubleshooting

  • Authentication errors: Ensure that the API key credential is correctly configured and has sufficient permissions to access failover scripts.
  • Invalid filter or search syntax: The $filter and $search parameters must follow the expected OData or API-specific syntax. Incorrect syntax may result in errors or empty results.
  • Pagination issues: Using $top and $skip incorrectly (e.g., negative numbers or non-numeric strings) might cause unexpected behavior or errors.
  • Empty responses: If no failover scripts match the criteria, the output will be empty; verify filters and search terms.
  • Server URL misconfiguration: The base URL must be correctly set without trailing slashes; otherwise, requests may fail.

Links and References

Discussion