3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically to retrieve a DN (Directory Number) property by its name. It is useful in scenarios where you need to programmatically access specific configuration or status properties of a DN within the 3CX system, such as fetching user settings, call forwarding rules, or other DN-related metadata.

For example, if you want to automate monitoring or reporting on certain DN attributes, this node can fetch those values dynamically based on the DN number and the property name you specify.

Properties

Name Meaning
Dn Number The directory number (DN) identifier for which you want to retrieve a property. Usage: dnNumber={dnNumber}
Name The name of the DN property you want to get. Usage: name={name}

Output

The output JSON will contain the value of the requested DN property for the specified DN number. The exact structure depends on the 3CX API response but generally includes the property name and its corresponding value.

No binary data output is expected from this operation.

Dependencies

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

Troubleshooting

  • Invalid DN Number or Property Name: If the DN number or property name does not exist, the node may return an error or empty result. Verify that both inputs are correct and exist in the 3CX system.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access DN properties.
  • Network Issues: Confirm that the 3CX server URL is reachable from the n8n instance.
  • Malformed Input: Make sure the input strings for DN number and property name do not contain invalid characters or whitespace.

Links and References

Discussion