3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

This node allows users to create a new Ring Group within the 3CX telephony system. Ring Groups are used to manage how incoming calls are distributed among a group of extensions or members, enabling efficient call handling and routing strategies.

Common scenarios for this node include:

  • Setting up a team or department call group where calls ring sequentially or simultaneously.
  • Configuring special routing rules for holidays, out-of-office hours, or no-answer situations.
  • Enabling or disabling communication channels like chat, phone, or video for the group.
  • Managing call requirements such as collecting caller name or email before connecting.

Practical example:
A customer support manager wants to create a Ring Group that rings all support agents simultaneously, enables chat and video calls, requires callers to provide both their name and email, and has specific routing for holidays and after-hours.

Properties

Name Meaning
Break Route JSON object defining the call routing behavior when a break occurs in the ring group.
Call Us Enable Chat Boolean to enable or disable chat functionality for the ring group.
Call Us Enable Phone Boolean to enable or disable phone calls for the ring group.
Call Us Enable Video Boolean to enable or disable video calls for the ring group.
Call Us Requirement Option to specify caller information requirement before connecting: Both (name and email), Name only, Email only, or None.
Click To Call Id String identifier for click-to-call integration associated with the ring group.
Forward No Answer JSON object defining routing behavior if no one answers the call in the ring group.
Greeting File String specifying the file path or identifier for the greeting audio played to callers.
Groups JSON array describing groups with rights and tags associated with the ring group.
Holidays Route JSON object defining call routing during holidays.
Id Numeric identifier for the ring group (usually assigned by the system).
Is Registered Boolean indicating whether the ring group is registered/enabled.
Members JSON array listing members (extensions/users) included in the ring group.
Multicast Address String specifying the multicast IP address used for paging or group calls.
Multicast Codec String specifying the codec used for multicast calls.
Multicast Packet Time Number indicating packet time for multicast calls.
Multicast Port Number specifying the port used for multicast calls.
Name String name of the ring group.
Number String phone number associated with the ring group.
Out Of Office Route JSON object defining call routing when the ring group is out of office.
Ring Strategy Option defining how calls are distributed: Hunt (sequential), Ring All (simultaneous), or Paging.
Ring Time Number of seconds the phone rings before moving to the next step (e.g., forwarding).
Transcription Mode Option specifying transcription settings: Nothing, Voicemail, Recordings, Both, or Inherit from system defaults.

Output

The node outputs JSON data representing the newly created Ring Group object as returned by the 3CX API. This includes all properties set during creation along with any additional metadata or identifiers assigned by the system.

If binary data were involved (e.g., audio files), it would be handled separately, but this operation focuses on JSON data.

Dependencies

  • Requires an active connection to a 3CX telephony system via its API.
  • 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 uses HTTP requests to communicate with the 3CX API endpoint /xapi/v1.

Troubleshooting

  • Invalid JSON in properties: Several properties expect JSON input (e.g., Break Route, Forward No Answer). 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 configuration.
  • Missing required fields: Properties like Name and Number are essential; omitting them may cause API errors.
  • Incorrect routing objects: Routing properties must follow the expected structure defined by 3CX; incorrect formats can lead to failed requests.
  • Network issues: Connectivity problems to the 3CX server will prevent successful API calls.

Links and References

Discussion