3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically allowing users to retrieve information about a peer (a phone user or extension) by their phone number. It is useful in scenarios where you need to look up details of a specific phone user within the 3CX system based on their international phone number. For example, a customer support workflow could use this node to fetch caller details automatically when a call comes in, enabling personalized service.

Properties

Name Meaning
Number The phone number of the peer in international format (e.g., +1234567890). This is required.

Output

The node outputs JSON data representing the peer's details retrieved from the 3CX system. This typically includes information such as the peer's ID, name, extension, status, and other relevant attributes defined by the 3CX API. The output does not include binary data.

Dependencies

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

Troubleshooting

  • Invalid or missing phone number: Ensure the "Number" property is provided in the correct international format (e.g., +1234567890).
  • Authentication errors: Verify that the OAuth2 credentials are correctly set up and have not expired.
  • Connection issues: Confirm the 3CX server URL is correct and accessible from the n8n instance.
  • Peer not found: If no peer matches the given number, the node may return an empty result or an error; verify the number exists in the 3CX system.

Links and References

Discussion