3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system to list device information. It retrieves details about devices registered or connected within the 3CX environment. This is useful for administrators who want to monitor, audit, or manage telephony devices programmatically.

Common scenarios include:

  • Fetching a list of all devices currently connected or registered.
  • Filtering devices based on status or other properties.
  • Paginating through large sets of device data.
  • Selecting specific device properties to optimize data retrieval.

Example: An admin could use this node to get the first 10 connected devices sorted by name, or search for devices matching a particular keyword.

Properties

Name Meaning
Options A collection of query parameters to customize the device info listing:
- Top ($top) Show only the first n items (pagination limit).
- Skip ($skip) Skip the first n items (pagination offset).
- Search ($search) Search items by phrases; supports automatic quoting if phrase contains spaces.
- 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).

Output

The node outputs JSON data representing the list of device information objects retrieved from the 3CX API. Each item corresponds to a device and includes properties as requested via the $select option or defaults provided by the API.

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

No binary data output is indicated.

Dependencies

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

Troubleshooting

  • Authentication errors: Ensure the API key or OAuth2 token is valid and has sufficient permissions.
  • Network errors: Verify the 3CX server URL is correct and reachable from the n8n instance.
  • Invalid query parameters: Incorrect filter, orderby, or select syntax can cause API errors. Validate expressions against 3CX API documentation.
  • Empty results: Check that filters or search terms are not too restrictive.
  • Pagination issues: When using $top and $skip, ensure values are numeric strings.

Links and References

Discussion