3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node interacts with the 3CX telephony system to retrieve inbound rules report data. It is useful for users who want to analyze or monitor inbound call routing rules configured in their 3CX system. Typical scenarios include generating reports on how calls are routed, filtering inbound rules based on specific criteria, and exporting subsets of inbound rule data for further processing or auditing.

For example, a user might want to fetch only the top 10 inbound rules sorted by creation date or search for inbound rules containing a particular keyword.

Properties

Name Meaning
Options A collection of 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 automatically)
- Filter: Filter items by property values (e.g., State eq 'Connected')
- Count: Include count of items (boolean)
- Select: Select properties to be returned (comma-separated list, e.g., Id,Name)
- Orderby: Order items by property values (e.g., Name desc, CreatedAt asc)
- Expand: Expand related entities (comma-separated list of related entities to expand)

These options allow fine-grained control over the data retrieved from the 3CX API, enabling filtering, sorting, pagination, and selection of specific fields.

Output

The node outputs JSON data representing the inbound rules retrieved from the 3CX system. The structure corresponds directly to the API response and includes details about each inbound rule according to the selected properties.

If binary data were involved (not indicated here), it would typically represent files or media associated with the inbound rules, but this node focuses on JSON data output.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token credential configured in n8n to authorize requests.
  • The base URL for the 3CX API must be provided via credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate query parameters.

Troubleshooting

  • Authentication errors: Ensure that the API authentication token is valid and has sufficient permissions to access inbound rules data.
  • Invalid query parameters: Incorrect filter, search, or orderby syntax may cause API errors. Verify the syntax matches 3CX API expectations.
  • Empty results: If no data is returned, check if filters or search terms are too restrictive.
  • Network issues: Confirm that the 3CX server URL is reachable from the n8n instance.

Links and References

Discussion