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 list inbound rules configured in their 3CX environment. It is useful for scenarios where you want to retrieve and manage call routing rules, such as automating reporting on inbound call handling or integrating inbound rule data into other workflows.

For example, a user might use this node to fetch all inbound rules that are currently active or filter them by certain criteria like name or state, then process or display this information elsewhere.

Properties

Name Meaning
Options A collection of optional query parameters to customize the listing of inbound rules:
- 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)
- Orderby: Order items by property values (e.g., Name desc, CreatedAt asc)
- Select: Select specific properties to be returned (e.g., Id,Name)
- Expand: Expand related entities (e.g., RelatedEntity1,RelatedEntity2)

These options correspond to OData-style query parameters that control how the inbound rules are retrieved from the 3CX API.

Output

The node outputs JSON data representing the list of inbound rules retrieved from the 3CX system. Each item in the output array corresponds to an inbound rule object with properties depending on the selected fields or defaults from the API.

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 metadata.

Dependencies

  • Requires an API key credential for authenticating with the 3CX server.
  • The node expects a base URL for the 3CX API server, which must be provided in the credentials.
  • The node uses HTTP requests with JSON responses, relying on the 3CX REST API endpoint /xapi/v1.

Troubleshooting

  • Authentication errors: Ensure the API key or OAuth2 token is valid and has sufficient permissions to access inbound rules.
  • Invalid query parameters: Incorrect syntax in filter, orderby, or search options may cause API errors. Validate OData query strings carefully.
  • Empty results: If no inbound rules are returned, check if filters or search terms are too restrictive.
  • Network issues: Verify connectivity to the 3CX server URL and that the server is reachable.

Links and References

Discussion