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 website links (weblinks) that can be used for communication purposes such as calls, chat, and meetings. The "Create Weblink" operation enables the creation of customized weblinks with various settings including enabling/disabling calls, chat, meetings, reCAPTCHA protection, and styling options.

Common scenarios where this node is beneficial include:

  • Generating custom communication links for websites or applications to enable direct calling, chatting, or meeting scheduling via 3CX.
  • Automating the creation of communication entry points for customer support or sales teams.
  • Managing multiple communication channels with specific configurations per link.

Practical example:

  • A company wants to embed a chat box and call button on their website. Using this node, they can programmatically create a weblink with chat and call enabled, styled according to their branding, and protected by reCAPTCHA to prevent spam.

Properties

Name Meaning
Advanced JSON object for advanced configuration options of the weblink.
Calls Enabled Boolean flag to enable or disable call functionality on the weblink.
Chat Box JSON object defining the chat box configuration details.
Chat Enabled Boolean flag to enable or disable chat functionality on the weblink.
Default Record Boolean indicating if this weblink should be set as the default record.
DN JSON object containing membership and tagging information related to the weblink.
Enable Re Captcha Boolean to enable or disable Google reCAPTCHA protection on the weblink.
General JSON object for general settings of the weblink.
Group String specifying the group associated with the weblink.
Hidden Boolean indicating whether the weblink is hidden from public view.
Id Numeric identifier for the weblink.
Link String URL or path representing the actual weblink destination.
Meeting Enabled Boolean flag to enable or disable meeting functionality on the weblink.
Name String name of the weblink.
Styling JSON object defining styling options for the weblink appearance.
Translations JSON object containing translations for the weblink content in different languages.
Website JSON array containing website-related data or references associated with the weblink.

Output

The node outputs JSON data representing the created weblink resource as returned by the 3CX API. This typically includes all properties sent during creation along with any additional metadata assigned by the server, such as unique identifiers or status fields.

If the node supports binary data output (not indicated here), it would represent attachments or files related to the weblink, but based on the provided code and properties, the output is purely JSON.

Dependencies

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

Troubleshooting

  • Authentication errors: Ensure that the API credentials are valid and have not expired. Check that the OAuth2 token or API key is correctly configured.
  • Invalid JSON in properties: Several properties expect JSON input (e.g., Advanced, ChatBox, DN). Invalid JSON formatting will cause parsing errors. Validate JSON syntax before sending.
  • Missing required fields: Some fields like Name or Link might be mandatory for successful creation. Verify these are provided and non-empty.
  • API endpoint issues: Confirm the base URL is correct and accessible from the n8n environment.
  • Permission denied: The authenticated user may lack permissions to create weblinks. Verify user roles and privileges in 3CX.

Links and References

Discussion