3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node integrates with the 3CX telephony system, specifically allowing users to update a Call Flow App within 3CX. Call Flow Apps are programmable call handling scripts that define how incoming calls are processed and routed. This operation is useful for automating updates to call flow configurations, such as changing routing rules, updating scripts, or modifying registration status.

Practical scenarios include:

  • Automatically updating call flow apps based on external triggers or data changes.
  • Managing call routing dynamically without manual intervention in the 3CX management console.
  • Integrating call flow app updates into broader workflows, e.g., syncing with CRM or support ticket systems.

Properties

Name Meaning
Id The unique identifier of the Call Flow App to update. Can be set via expression like {{$json.Id}}.
Compilation Last Success Timestamp or string indicating the last successful compilation time of the call flow script.
Compilation Result Result message or details from the last compilation attempt of the call flow script.
Compilation Succeeded Boolean flag indicating if the last compilation was successful.
Groups JSON array defining group rights, tags, and permissions associated with the call flow app.
Invalid Script Boolean indicating whether the current script is invalid.
Is Registered Boolean indicating if the call flow app is currently registered in the system.
Name The name of the Call Flow App.
Number The phone number associated with the Call Flow App.
Rejected Code Code or message indicating why a call or script was rejected.
Routing Type Defines how calls are routed; options: Dial Code, Forward, Trunk.
Script Code The actual script code used by the Call Flow App to control call behavior.
Transcription Mode Mode for call transcription; options: Nothing, Voicemail, Recordings, Both, Inherit.
Trunk Complex JSON object describing trunk configuration including authentication, routing rules, groups, and other telephony settings.

Output

The node outputs JSON data representing the updated Call Flow App entity as returned by the 3CX API. This typically includes all properties of the call flow app after the update, such as its ID, name, script status, routing information, and any compilation results.

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

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • Needs the 3CX server URL configured in credentials.
  • The node uses the 3CX REST API endpoint /xapi/v1 for requests.
  • No additional external dependencies beyond the 3CX API and proper OAuth2 or API key credentials.

Troubleshooting

  • Invalid Script Errors: If the Invalid Script property is true or compilation fails, verify the syntax and logic of the Script Code. Use the Compilation Result for detailed error messages.
  • Authentication Failures: Ensure the API key or OAuth2 token is valid and has sufficient permissions to update call flow apps.
  • Missing or Incorrect Id: The Id property must be correctly set to identify which call flow app to update. Using an incorrect or missing ID will cause errors.
  • JSON Parsing Issues: For complex JSON fields like Groups and Trunk, ensure the JSON is well-formed. Malformed JSON will cause request failures.
  • Routing Type Mismatch: Setting an unsupported routing type may cause the update to fail. Use one of the provided options only.

Links and References

Discussion