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 details about a single inbound rule by its unique identifier. It is useful in scenarios where you need to fetch configuration or status information about specific inbound call routing rules within 3CX, for example, to audit call handling setups or integrate inbound rule data into other workflows.

Properties

Name Meaning
Id The unique identifier of the inbound rule to retrieve. Can be set directly or via expression.
Options Additional query options:
- $select Comma-separated list of properties to return for the inbound rule (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 requested inbound rule entity from the 3CX system. The structure includes all selected properties and any expanded related entities as specified in the options. This output can be used downstream in workflows for further processing or decision-making.

Dependencies

  • Requires an API authentication token credential configured for 3CX OAuth2.
  • Needs the base URL of the 3CX server to be set in 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 correctly references an existing inbound rule.
  • Authentication errors: Verify that the API authentication token is valid and has sufficient permissions.
  • Network or URL issues: Confirm the 3CX server URL is correct and accessible from n8n.
  • Incorrect $select or $expand values: Use valid property names and related entity names supported by the 3CX API to avoid errors or empty responses.

Links and References

  • 3CX API documentation (refer to official 3CX developer resources for detailed API specs)
  • OAuth2 authentication setup guides for 3CX integrations

Discussion