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 information about a single receptionist entity by its unique identifier. It is useful in scenarios where you need to fetch detailed data about a receptionist configured in the 3CX system, such as for display in dashboards, integration with CRM systems, or automated workflows that depend on receptionist details.

For example, you might use this node to:

  • Retrieve the profile of a receptionist to verify their status or contact details.
  • Integrate receptionist information into a customer support workflow.
  • Automate updates or notifications based on receptionist attributes.

Properties

Name Meaning
Id The unique identifier of the receptionist entity to retrieve. Supports expressions like {{$json.Id}}. This is a required numeric field.
Options A collection of optional query parameters:
- Select ($select) Comma-separated list of specific properties of the receptionist to return (e.g., Id,Name).
- 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 receptionist entity retrieved from the 3CX system. The structure of the JSON depends on the selected properties and expansions specified in the options. Typically, it includes fields such as the receptionist's ID, name, and any expanded related entities.

If binary data were involved (not indicated here), it would be summarized accordingly, but this node focuses on JSON data output.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node expects a base URL for the 3CX server, which should be 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 corresponds to an existing receptionist entity. Using an invalid or zero value may result in errors or empty responses.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions to access receptionist data.
  • Network or URL issues: Confirm that the 3CX server URL is correct and accessible from the n8n environment.
  • Incorrect $select or $expand values: Using invalid property names in these options may cause the API to reject the request or return incomplete data. Use valid property names as defined by the 3CX API documentation.

Links and References

Discussion