3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically allowing users to retrieve details of a single Trunk Template by its unique identifier. This operation is useful when you want to fetch configuration or metadata about a specific trunk template within your 3CX environment, for example, to display its settings, verify its properties, or use its data in further workflow steps.

Practical examples include:

  • Fetching a trunk template's details to validate its configuration before applying changes.
  • Retrieving trunk template information to synchronize with an external system.
  • Using trunk template data dynamically in call routing or reporting workflows.

Properties

Name Meaning
Id The unique identifier of the trunk template to retrieve. Supports expressions like {{$json.Id}}.
Options Additional query options:
- Select: Specify which properties of the trunk template to return (e.g., Id,Name).
- Expand: Expand related entities to include their data inline (e.g., RelatedEntity1,RelatedEntity2).

Output

The node outputs JSON data representing the requested trunk template entity. The structure corresponds to the properties of the trunk template as returned by the 3CX API, potentially filtered or expanded based on the provided options.

If the user specifies $select, only those selected properties will be present in the output JSON. If $expand is used, related entities' data will be included inline.

No binary data output is indicated for this operation.

Dependencies

  • Requires an active connection to a 3CX telephony system via an OAuth2-based API credential.
  • The node expects the base URL of the 3CX server to be configured in the credentials.
  • The node sends requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Missing or invalid Id: The operation requires a valid trunk template ID. Ensure the Id property is set and correctly references an existing trunk template.
  • Authentication errors: Verify that the API authentication token or OAuth2 credentials are correctly configured and have sufficient permissions.
  • Network or connectivity issues: Confirm that the 3CX server URL is reachable from n8n and that no firewall or network restrictions block access.
  • Invalid $select or $expand values: Providing incorrect property names in these options may result in empty or error responses. Use valid property names as defined by the 3CX API documentation.

Links and References

Discussion