3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically providing an operation to list fax records. It allows users to retrieve a collection of fax items from their 3CX environment with flexible query options such as filtering, searching, ordering, and pagination. This is useful for scenarios where you want to automate monitoring or processing of faxes received or sent through 3CX, generate reports, or trigger workflows based on fax data.

For example, you could use this node to:

  • Retrieve the latest 10 faxes received.
  • Search for faxes containing specific keywords.
  • Filter faxes by status or date.
  • Order faxes by creation date descending.
  • Select only certain properties like fax ID and sender information.

Properties

Name Meaning
Options A collection of optional query parameters to customize the list of faxes returned:
- Top ($top) Show only the first n items (limit results).
- Skip ($skip) Skip the first n items (offset for pagination).
- Search ($search) Search items by search phrases; supports phrase quoting automatically if needed.
- Filter ($filter) Filter items by property values using OData filter syntax (e.g., State eq 'Connected').
- Count ($count) Include count of total items in the response (boolean).
- Orderby ($orderby) Order items by property values (e.g., Name desc, CreatedAt asc).
- Select ($select) Select specific properties to be returned (e.g., Id,Name).
- Expand ($expand) Expand related entities to include additional linked data.

Output

The node outputs JSON data representing the list of fax items retrieved from the 3CX API. The structure corresponds to the properties selected or returned by default from the API. If the $count option is enabled, the output will also include the total count of matching fax items.

No binary data output is indicated for this operation.

Dependencies

  • Requires connection to a 3CX telephony system instance.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The base URL for the 3CX API must be provided in the credentials configuration.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is valid and has sufficient permissions to access fax data.
  • Invalid query parameters: Using incorrect syntax in filter, orderby, or search fields may cause API errors. Validate OData query expressions carefully.
  • Empty results: Check if the filter or search criteria are too restrictive or if there are no fax records matching the query.
  • Network issues: Verify connectivity to the 3CX server URL and that it is correctly set without trailing slashes.

Links and References

Discussion