3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to download reports on inbound rules. It is useful for users who want to retrieve detailed information about how incoming calls are handled or routed within their 3CX environment. Typical scenarios include auditing call routing configurations, monitoring inbound call handling, or integrating 3CX inbound rule data into other workflows or reporting tools.

For example, a user might use this node to fetch the top 10 inbound rules sorted by creation date to analyze recent changes or to filter inbound rules that are currently active or connected.

Properties

Name Meaning
Options A collection of optional query parameters to customize the data retrieval:
- Top: Show only the first n items
- Skip: Skip the first n items
- Search: Search items by search phrases (supports phrase quoting)
- Filter: Filter items by property values (e.g., State eq 'Connected')
- Count: Include count of items (boolean)
- Select: Select specific properties to be returned (comma-separated list)
- Orderby: Order items by property values (e.g., Name desc, CreatedAt asc)
- Expand: Expand related entities (comma-separated list)

These options allow fine-grained control over the query sent to the 3CX API to tailor the results according to user needs.

Output

The node outputs JSON data representing the inbound rules retrieved from the 3CX system. The structure corresponds to the properties selected or returned by default from the 3CX API's inbound rules endpoint.

  • The json output field contains an array of inbound rule objects.
  • Each object includes details such as identifiers, names, states, and any other properties requested via the $select option.
  • If the Count option is enabled, the output may also include metadata about the total number of items matching the query.
  • No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node expects a base URL for the 3CX server, configured in the credentials.
  • The node sends HTTP requests with JSON headers to the 3CX API endpoint /xapi/v1.
  • Proper network access to the 3CX server is necessary.

Troubleshooting

  • Authentication errors: Ensure the API key or OAuth2 token is valid and has sufficient permissions.
  • Network errors: Verify the 3CX server URL is correct and accessible from the n8n instance.
  • Invalid query parameters: Incorrect syntax in filter, orderby, or search options can cause API errors; validate these strings carefully.
  • Empty results: Adjust filters or remove restrictive options like $top or $filter to confirm data availability.
  • API limits: Large queries without pagination ($top and $skip) might time out or be rejected; use these options to paginate results.

Links and References

Discussion