3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system to create inbound call routing rules. It allows users to define how incoming calls are handled based on various conditions such as call type, time periods (office hours, holidays, out of office hours), and caller information. This is useful for automating call management in business phone systems, ensuring calls are routed appropriately during different scenarios like holidays or outside working hours.

Practical examples include:

  • Forwarding calls to a specific destination during holidays.
  • Routing calls differently when the phone line is busy or not registered.
  • Altering call destinations based on caller ID or direct inward dialing (DID).
  • Setting up custom handling for internal versus external calls.

Properties

Name Meaning
Alter Destination During Holidays Boolean flag to enable or disable altering the call destination during holidays.
Alter Destination During Out Of Office Hours Boolean flag to enable or disable altering the call destination during out-of-office hours.
Call Type Specifies which types of calls the rule applies to. Options: All Calls, Internal Calls Only, External Calls Only.
Condition The condition under which the inbound rule triggers. Options: No Answer, Phone Busy, Phone Not Registered, Forward All, Based On Caller ID, Based On DID.
Custom Data A string field for any additional custom data related to the inbound rule.
Data A string field for extra data associated with the rule.
Holidays Destination JSON object defining the call destination(s) during holidays. Typically includes tags or identifiers for routing.
Hours JSON object specifying the time periods (e.g., office hours) during which the rule applies.
Id Numeric identifier for the inbound rule.
Office Hours Destination JSON object defining the call destination(s) during office hours.
Out Of Office Hours Destination JSON object defining the call destination(s) during out-of-office hours.
Rule Name The name of the inbound rule.
Trunk DN JSON object describing trunk direct numbers involved in the rule, including membership and tags.

Output

The node outputs JSON data representing the created inbound rule as returned by the 3CX API. This typically includes all properties of the newly created rule such as its ID, name, conditions, destinations, and other metadata confirming successful creation.

If binary data were involved (not indicated here), it would represent files or media related to the rule configuration, but this node focuses on JSON structured data only.

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 server must be provided in the node credentials.
  • The node sends requests to the 3CX REST API endpoint /xapi/v1.

Troubleshooting

  • Invalid JSON in properties: Some properties expect JSON input (e.g., HolidaysDestination, Hours). Ensure valid JSON syntax to avoid parsing errors.
  • Authentication errors: If the API key or OAuth2 token is missing or invalid, the node will fail to authenticate. Verify credentials are correctly set up.
  • Incorrect property values: Using unsupported options or malformed data may cause the API to reject the request. Double-check property values against allowed options.
  • Network issues: Connectivity problems to the 3CX server will prevent rule creation. Confirm network access and correct server URL.
  • API errors: The 3CX API might return errors if the rule conflicts with existing configurations or violates constraints. Review error messages for details.

Links and References

Discussion