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 create a new Call Flow App within 3CX. Call Flow Apps are programmable call handling scripts that define how incoming calls are processed and routed in the telephony system.

Typical use cases include automating call routing based on business hours, caller input, or other logic; managing voicemail and transcription settings; and integrating with external systems for advanced call control.

For example, a user might create a Call Flow App that routes calls to different departments depending on the time of day or plays custom messages before forwarding calls.

Properties

Name Meaning
Compilation Last Success Timestamp or string indicating the last successful compilation of the call flow script.
Compilation Result Result message or status from the last compilation attempt of the call flow script.
Compilation Succeeded Boolean flag indicating whether the last compilation of the call flow script succeeded.
Groups JSON array defining group permissions, rights, and tags associated with the call flow app.
Id Numeric identifier for the call flow app (usually assigned by the system).
Invalid Script Boolean indicating if the current script is invalid.
Is Registered Boolean indicating if the call flow app is registered/enabled in the system.
Name The display name of the call flow app.
Number Phone number associated with the call flow app.
Rejected Code String code representing rejection reasons or statuses.
Routing Type Method of routing calls; options: Dial Code, Forward, Trunk.
Script Code The actual scripting code controlling call flow behavior.
Transcription Mode Defines transcription settings; options: Nothing, Voicemail, Recordings, Both, Inherit.
Trunk Complex JSON object describing trunk configuration including authentication, routing rules, groups, messaging, and more.

Output

The node outputs JSON data representing the created Call Flow App as returned by the 3CX API. This includes all properties sent during creation along with any additional metadata or identifiers assigned by the server.

If binary data were involved (e.g., audio files), it would be included separately, but this operation focuses on JSON data describing call flow configurations.

Dependencies

  • Requires an active connection to a 3CX telephony system.
  • Needs an API authentication token or OAuth2 credential configured in n8n to authorize requests.
  • The base URL of the 3CX server must be provided in credentials.
  • The node sends HTTP requests to the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Invalid Script Errors: If the Invalid Script property is true or compilation fails, verify the syntax and logic of the Script Code.
  • Authentication Failures: Ensure the API key or OAuth2 token is valid and has sufficient permissions.
  • Routing Type Mismatch: Confirm that the selected routing type matches the expected configuration on the 3CX server.
  • JSON Parsing Issues: For complex JSON inputs like Groups or Trunk, ensure the JSON is well-formed and correctly structured.
  • Network Errors: Check connectivity to the 3CX server and that the base URL is correct without trailing slashes.

Links and References

Discussion