3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically providing an operation to list FXs (likely referring to fax devices or fax-related entities within 3CX). It allows users to retrieve a filtered, sorted, and paginated list of FXs from their 3CX instance. This is useful for scenarios such as managing fax devices, auditing fax configurations, or integrating fax data into workflows.

Practical examples:

  • Retrieve the first 10 fax devices currently connected.
  • Search for fax devices by name or status.
  • Get a count of all fax devices matching certain criteria.
  • Expand related entities to get detailed information about each fax device.

Properties

Name Meaning
Options Collection of query options to customize the list 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 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)

Output

The output JSON field contains an array of FX objects retrieved from the 3CX API according to the specified query parameters. Each object represents an FX entity with its properties as returned by the API. If the $count option is enabled, the response may also include a total count of matching 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.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Invalid query parameters (e.g., malformed filter expressions) may result in API errors.
    • Network connectivity issues can prevent communication with the 3CX server.

  • Error messages:

    • Authentication errors typically indicate invalid or expired credentials; reconfigure the API key.
    • Query syntax errors suggest incorrect usage of OData-like query options; verify filter, orderby, and search syntax.
    • Timeout or connection errors require checking network access and server availability.

Links and References

  • 3CX API documentation (refer to official 3CX developer resources for details on FX entities and query parameters)
  • OData query options reference (for understanding $filter, $orderby, $select, etc.)

Discussion