3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The node provides an operation to update a Ring Group configuration in the 3CX telephony system. Ring Groups are used to manage how incoming calls are distributed among a group of members, such as a team or department. This operation allows users to modify various settings of an existing Ring Group, including call routing strategies, member lists, greetings, and other telephony features.

Common scenarios for this node include:

  • Adjusting call distribution methods (e.g., hunt, ring all, paging) for a sales or support team.
  • Updating members of a Ring Group dynamically based on organizational changes.
  • 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 Ring Group.
  • Managing voicemail transcription preferences.

Practical example: A customer support manager wants to update the Ring Group to add new team members, change the ring strategy to "Ring All," and set a custom greeting file for callers during holidays. Using this node, they can automate these updates within their workflow.

Properties

Name Meaning
Id The unique identifier of the Ring Group entity to update. Can be provided directly or via expression (e.g., from previous node data).
Break Route JSON object defining the call routing behavior when a break occurs, including tags for routing logic.
Call Us Enable Chat Boolean flag to enable or disable chat functionality for the Ring Group.
Call Us Enable Phone Boolean flag to enable or disable phone calls for the Ring Group.
Call Us Enable Video Boolean flag to enable or disable video calls for the Ring Group.
Call Us Requirement Specifies required caller information before connecting: options are "Both" (name and email), "Name", "Email", 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 a call is not answered, including tags.
Greeting File String URL or identifier for a greeting audio file played to callers.
Groups JSON array describing groups related to the Ring Group, including rights and tags.
Holidays Route JSON object defining call routing during holidays, including tags.
Is Registered Boolean indicating whether the Ring Group is registered/enabled.
Members JSON array listing members of the Ring Group, each member defined by its own properties.
Multicast Address String specifying the multicast IP address used for group calls.
Multicast Codec String specifying the codec used for multicast calls.
Multicast Packet Time Number indicating packet time for multicast transmission.
Multicast Port Number specifying the port used for multicast calls.
Name The display name of the Ring Group.
Number The phone number associated with the Ring Group.
Out Of Office Route JSON object defining call routing when the Ring Group is out of office, including tags.
Ring Strategy Call distribution strategy for the Ring Group. Options: "Hunt" (calls one member at a time), "Ring All" (calls all members simultaneously), "Paging" (sequential paging).
Ring Time Number of seconds the phone rings before moving to the next action (e.g., forwarding).
Transcription Mode Voicemail transcription mode. Options: "Nothing", "Voicemail", "Recordings", "Both", "Inherit".

Output

The node outputs the response from the 3CX API after updating the Ring Group. The output is structured as JSON containing the updated Ring Group details or status confirmation. It does not explicitly handle binary data.

Typical fields in the output JSON may include updated properties of the Ring Group such as its ID, name, members, routing configurations, and status flags.

Dependencies

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

Troubleshooting

  • Invalid Id: If the provided Ring Group Id does not exist, the API will return an error. Verify the Id is correct and accessible.
  • Malformed JSON properties: Properties like BreakRoute, ForwardNoAnswer, Groups, HolidaysRoute, OutOfOfficeRoute, and Members expect valid JSON strings. Invalid JSON will cause parsing errors. Use proper JSON formatting or expressions that produce valid JSON.
  • Authentication errors: Ensure the API credentials are correctly configured and have sufficient permissions to update Ring Groups.
  • Network issues: Confirm the 3CX server URL is reachable from the n8n environment.
  • Unsupported values: For options like RingStrategy or TranscriptionMode, use only the allowed values to avoid API rejection.

Links and References

Discussion