3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system, specifically allowing users to retrieve detailed information about a contact by its unique identifier. It is useful in scenarios where you need to fetch contact details dynamically during workflow execution, such as integrating telephony data with CRM systems or automating call routing based on contact information.

For example, you might use this node to get a contact's phone number and name before initiating an outbound call or logging call details into another system.

Properties

Name Meaning
Id The unique identifier of the contact entity to retrieve. Can be set statically or via expression (e.g., {{$json.Id}}). Must be a number.
Options Additional query options to customize the returned data:
- $select Comma-separated list of specific properties of the contact to return (e.g., Id,Name).
- $expand Comma-separated list of related entities to expand and include in the response.

Output

The node outputs JSON data representing the contact entity retrieved from the 3CX system. The structure of the JSON depends on the selected properties and expanded related entities specified in the options. This typically includes fields like contact ID, name, phone numbers, and any other requested attributes.

No binary data output is indicated.

Dependencies

  • Requires an API authentication token credential for the 3CX system.
  • Needs the base URL of the 3CX server configured in the credentials.
  • The node sends requests to the 3CX REST API endpoint /xapi/v1.

Troubleshooting

  • Invalid or missing Id: Ensure the Id property is provided and is a valid number. Using expressions that resolve to undefined or non-numeric values will cause errors.
  • Authentication errors: Verify that the API key or OAuth2 token is correctly configured and has sufficient permissions.
  • Network or URL issues: Confirm the 3CX server URL is correct and accessible from the n8n instance.
  • Incorrect $select or $expand values: Using invalid property names may result in incomplete data or API errors. Refer to 3CX API documentation for valid fields.

Links and References

Discussion