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 firmware information. This operation retrieves a list of firmware items from the 3CX API, allowing users to query and filter firmware data according to various criteria.

Common scenarios where this node is beneficial include:

  • Automating inventory or audit processes by fetching current firmware versions.
  • Integrating firmware data into broader workflows for device management.
  • Filtering and sorting firmware records to identify updates or specific firmware states.

For example, a user might configure the node to retrieve only the top 10 latest firmware entries or search for firmware matching a particular keyword.

Properties

Name Meaning
Options A collection of optional query parameters to customize the firmware list request:
- Top ($top) Show only the first n items (limit results).
- Skip ($skip) Skip the first n items (offset results).
- Search ($search) Search items by search phrases; supports phrase quoting automatically if needed.
- Filter ($filter) Filter items by property values using expressions (e.g., State eq 'Connected').
- Count ($count) Include count of total items in the response (boolean).
- Orderby ($orderby) Order items by specified 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 (e.g., RelatedEntity1).

These options allow fine-grained control over the data retrieved from the firmware list endpoint.

Output

The node outputs JSON data representing the list of firmware items retrieved from the 3CX API. The structure typically includes an array of firmware objects, each containing properties as requested via the $select option or default fields.

If the $count option is enabled, the output may also include metadata about the total number of firmware items available.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node expects a base URL for the 3CX API server, configured in the credentials.
  • The node sends requests to the /xapi/v1 endpoint of the 3CX API.

Troubleshooting

  • Authentication errors: Ensure that the API key or OAuth2 token is correctly configured and has sufficient permissions.
  • Invalid query parameters: Incorrect syntax in filter, orderby, or search strings can cause API errors. Validate expressions carefully.
  • Empty results: Check if filters or search terms are too restrictive or if the firmware data exists on the server.
  • Network issues: Verify connectivity to the 3CX API server URL and that it is reachable from the n8n environment.

Links and References

Discussion