3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Update Inbound Rule" operation for the "Inbound Rules" resource allows users to modify existing inbound call routing rules within a 3CX telephony system. This node is useful for administrators who want to programmatically update how incoming calls are handled based on various conditions such as holidays, office hours, caller ID, or call type.

Typical use cases include:

  • Changing the destination of calls during holidays or out-of-office hours.
  • Adjusting call forwarding behavior based on whether the call is internal or external.
  • Updating rules dynamically in response to business needs without manual intervention in the 3CX management console.

For example, an organization might automate updating inbound rules to redirect calls to a different department during holiday periods or after business hours.

Properties

Name Meaning
Id The unique identifier of the inbound rule to update. Can be set via expression like {{$json.Id}}.
Alter Destination During Holidays Boolean flag to determine if the call destination should change during holidays (true or false).
Alter Destination During Out Of Office Hours Boolean flag to determine if the call destination should change outside office hours (true or false).
Call Type Specifies which calls the rule applies to: All Calls, Internal Calls Only, or External Calls Only.
Condition The condition triggering the rule: No Answer, Phone Busy, Phone Not Registered, Forward All, Based On Caller ID, or Based On DID.
Custom Data A string field for any custom data associated with the inbound rule.
Data Additional string data related to the rule (purpose depends on context).
Holidays Destination JSON object defining the call destination during holidays, typically including tags or routing info.
Hours JSON object specifying time periods when the rule is active or applicable.
Office Hours Destination JSON object defining the call destination during office hours.
Out Of Office Hours Destination JSON object defining the call destination outside office hours.
Rule Name The name of the inbound rule.
Trunk DN JSON object describing trunk information, including membership and tags related to the trunk's directory number.

Output

The node outputs JSON data representing the updated inbound rule as returned by the 3CX API. This output includes all properties of the inbound rule after modification, reflecting the changes made.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node expects the base URL of the 3CX server to be configured in credentials.
  • The node sends requests to the 3CX REST API endpoint /xapi/v1.

Troubleshooting

  • Invalid Id: If the provided inbound rule ID does not exist, the API will return an error. Ensure the ID is correct and accessible.
  • Malformed JSON: Properties like HolidaysDestination, Hours, OfficeHoursDestination, OutOfOfficeHoursDestination, and TrunkDN expect valid JSON strings. Invalid JSON will cause parsing errors.
  • Authentication Errors: Missing or invalid API credentials will prevent successful updates.
  • Permission Issues: The authenticated user must have sufficient permissions to update inbound rules.
  • Incorrect Property Values: Using unsupported values for options like CallType or Condition may result in API rejection.

To resolve these issues:

  • Verify the inbound rule ID exists.
  • Validate JSON syntax before sending.
  • Confirm API credentials and permissions.
  • Use only supported option values as listed in the properties.

Links and References

Discussion