3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node interacts with the 3CX telephony system, specifically allowing users to update an existing Outbound Rule. This operation is useful for managing call routing rules dynamically within a 3CX environment. For example, administrators can modify outbound dialing patterns, priorities, and group associations without manually accessing the 3CX management console.

Common scenarios include:

  • Updating dial number ranges or prefixes to reflect new dialing plans.
  • Changing priority or route settings to optimize call flow.
  • Adjusting emergency rule flags or group memberships for compliance or operational changes.

Properties

Name Meaning
Id The unique identifier of the outbound rule to update. Can be set via expression like {{$json.Id}}.
DN Ranges JSON array defining dial number ranges that this rule applies to.
Emergency Rule Boolean flag indicating if this rule is an emergency rule (true/false).
Group Ids JSON array of group IDs associated with this outbound rule.
Group Names JSON array of group names associated with this outbound rule.
Name The name of the outbound rule.
Number Length Ranges String specifying allowed number length ranges for this rule.
Prefix String prefix used in matching numbers for this rule.
Priority Numeric priority of the outbound rule, determining its order of evaluation.
Routes JSON array defining routes associated with this outbound rule.

Output

The node outputs JSON data representing the updated outbound rule as returned by the 3CX API. This typically includes all properties of the outbound rule after the update, such as its ID, name, dial number ranges, priority, routes, and group associations.

If the node supports binary data output, it would relate to any file or media content returned by the API, but based on the provided information, the output is purely JSON.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token configured via OAuth2 credentials.
  • The base URL for the 3CX API must be correctly set in the node credentials.
  • The node uses the 3CX REST API endpoint /xapi/v1 for requests.

Troubleshooting

  • Invalid Id: If the provided Id does not correspond to an existing outbound rule, the API will return an error. Ensure the correct rule ID is used.
  • Malformed JSON: Properties like DNRanges, GroupIds, GroupNames, and Routes expect valid JSON arrays. Invalid JSON syntax will cause parsing errors.
  • Authentication Errors: Missing or invalid API credentials will prevent successful API calls. Verify OAuth2 token validity and permissions.
  • API Endpoint Issues: Incorrect or missing server URL in credentials can lead to connection failures. Confirm the base URL is properly configured.
  • Priority Conflicts: Setting duplicate priorities may cause unexpected behavior in rule evaluation order; ensure priorities are unique or logically ordered.

Links and References

Discussion