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 export Caller ID rules from the Inbound Rules resource. It is useful for scenarios where you need to retrieve and analyze caller identification rules configured in a 3CX system, such as auditing call routing policies or integrating these rules into other workflows.

For example, a user might want to export all Caller ID rules that match certain criteria (e.g., only active rules or those created after a specific date) to synchronize them with a CRM system or generate reports.

Properties

Name Meaning
Options A collection of query parameters to customize the export request:
- Top: Show only the first n items
- Skip: Skip the first n items
- Search: Search items by search phrases
- Filter: Filter items by property values (e.g., State eq 'Connected')
- Count: Include count of items (boolean)
- Select: Select properties to be returned (e.g., Id,Name)
- Orderby: Order items by property values (e.g., Name desc, CreatedAt asc)
- Expand: Expand related entities (e.g., RelatedEntity1,RelatedEntity2)

These options allow fine-grained control over which Caller ID rules are exported and how the data is shaped.

Output

The node outputs JSON data representing the Caller ID rules retrieved from the 3CX system. The structure corresponds to the queried properties and may include multiple Caller ID rule objects depending on the applied filters and limits.

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

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the node credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1 with appropriate query parameters based on user input.

Troubleshooting

  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions to access inbound rules.
  • Invalid query parameters: Incorrect filter, search, or orderby syntax can cause API errors. Verify OData query syntax used in these fields.
  • Empty results: If no Caller ID rules are returned, check if filters or search terms are too restrictive.
  • Network issues: Confirm the 3CX server URL is reachable and correctly set in credentials.

Links and References

Discussion