3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve detailed information about a specific device. The "Get Device Info" operation allows users to fetch properties of a device by specifying its unique identifier. This is useful in scenarios where you need to monitor, audit, or manage telephony devices programmatically within workflows, such as fetching device status, configuration details, or related entities.

Practical examples include:

  • Automatically retrieving device details when a new call is received.
  • Integrating device information into reporting dashboards.
  • Enriching customer support tickets with device metadata.

Properties

Name Meaning
Id The unique identifier of the device whose information you want to retrieve. Can be set via expression (e.g., {{$json.Id}}). Must be a number.
Options Additional query options to customize the data returned:
- Select ($select) Comma-separated list of specific properties to return for the device (e.g., Id,Name). If empty, all properties are returned.
- Expand ($expand) Comma-separated list of related entities to expand and include in the response (e.g., RelatedEntity1,RelatedEntity2).

Output

The node outputs JSON data representing the device's information as retrieved from the 3CX API. The structure includes the requested properties of the device and any expanded related entities if specified. The output can be used downstream in the workflow for further processing or decision-making.

No binary data output is indicated.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token configured via OAuth2 credentials.
  • The base URL for the 3CX API must be provided in the node credentials.
  • The node sends requests to the /xapi/v1 endpoint of the 3CX server.

Troubleshooting

  • Invalid or missing device Id: Ensure that the Id property is provided and corresponds to an existing device in the 3CX system.
  • Authentication errors: Verify that the OAuth2 credentials are correctly configured and have sufficient permissions.
  • Network or connectivity issues: Confirm that the 3CX server URL is reachable from the n8n instance.
  • Incorrect $select or $expand syntax: Use comma-separated lists without spaces; invalid values may cause the API to reject the request.
  • Empty or unexpected responses: Check if the device exists and if the user has access rights to view its details.

Links and References

Discussion