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 detailed information about a single trunk entity by its unique identifier. It is useful in scenarios where you need to fetch configuration or status details of a specific trunk within your 3CX setup, such as for monitoring, reporting, or further automation workflows.

For example, you might use this node to:

  • Retrieve the configuration details of a particular trunk before updating it.
  • Fetch trunk information to display in a dashboard.
  • Use trunk data as part of a larger workflow that manages telephony resources dynamically.

Properties

Name Meaning
Id The unique identifier of the trunk entity to retrieve. You can provide a static number or use an expression like {{$json.Id}}. This property is required.
Options Additional query options to customize the returned data:
- Select ($select) Specify which properties of the trunk to return, e.g., "Id,Name".
- Expand ($expand) Specify related entities to expand and include in the response, e.g., "RelatedEntity1,RelatedEntity2".

Output

The node outputs JSON data representing the requested trunk entity. The structure corresponds to the 3CX API's trunk object, including any selected properties and expanded related entities as specified in the options.

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

Dependencies

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

Troubleshooting

  • Invalid or missing Id: Ensure the Id property is set correctly and corresponds to an existing trunk entity. Using an incorrect or non-existent ID will result in errors or empty responses.
  • Authentication errors: Verify that the OAuth2 credentials are valid and have sufficient permissions to access trunk data.
  • Network issues: Confirm that the server URL is reachable and correctly formatted (no trailing slash).
  • Incorrect $select or $expand values: Providing invalid property names or related entities may cause the API to reject the request or ignore those parameters.

Links and References

  • 3CX API Documentation (for detailed info on trunk entities and query options)
  • n8n OAuth2 Credential Setup Guide (refer to n8n documentation for configuring OAuth2 credentials)

Discussion