3CX icon

3CX

Interact with 3CX telephony system

Actions462

Overview

This node allows users to create an outbound rule in the 3CX telephony system. Outbound rules define how outgoing calls are routed based on various criteria such as dialed number ranges, prefixes, and group memberships. This is useful for organizations that want to control call routing policies, prioritize certain routes, or apply emergency call handling.

Typical use cases include:

  • Defining specific dialing patterns and associating them with particular routes.
  • Setting up emergency call rules that override normal routing.
  • Grouping users or extensions and applying customized outbound call rules to those groups.
  • Prioritizing routes to optimize call quality or cost.

For example, a company might create an outbound rule that routes all calls starting with a certain prefix through a preferred carrier or applies special handling for emergency numbers.

Properties

Name Meaning
DN Ranges JSON array defining dialed number ranges that this rule applies to.
Emergency Rule Boolean flag indicating if this is an emergency rule (true/false).
Group Ids JSON array of group IDs to which this rule applies.
Group Names JSON array of group names to which this rule applies.
Id Numeric identifier for the outbound rule.
Name String name of the outbound rule.
Number Length Ranges String specifying allowed number length ranges for matching calls.
Prefix String prefix that must match the start of dialed numbers for this rule to apply.
Priority Numeric priority of the rule; lower numbers indicate higher priority.
Routes JSON array defining the routes associated with this outbound rule.

Output

The node outputs JSON data representing the created outbound rule as returned by the 3CX API. This typically includes all properties sent in the request along with any additional metadata or identifiers assigned by the server.

No binary data output is involved.

Dependencies

  • Requires an active connection to a 3CX telephony system via its REST API.
  • Needs an API authentication token configured in n8n credentials (OAuth2 or similar).
  • The base URL of the 3CX server must be provided in the credentials configuration.

Troubleshooting

  • Invalid JSON input: Since several properties expect JSON arrays (e.g., DN Ranges, Group Ids), ensure the JSON syntax is correct. Malformed JSON will cause errors.
  • Authentication errors: Verify that the API key or OAuth2 token is valid and has sufficient permissions to create outbound rules.
  • Missing required fields: Ensure mandatory properties like Name and at least one routing criterion (e.g., DN Ranges or Prefix) are provided.
  • API endpoint issues: Confirm the 3CX server URL is correct and accessible from the n8n instance.
  • Priority conflicts: If multiple rules have the same priority, routing behavior may be unpredictable; assign unique priorities.

Links and References

Discussion