3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Update Group" operation in the Groups resource allows users to modify the settings and properties of an existing group within the 3CX telephony system. This node is useful for administrators who want to programmatically update group configurations such as call handling modes, routing rules, member assignments, hours of operation, and other group-specific options.

Typical use cases include:

  • Changing call routing behavior during holidays or breaks.
  • Updating group members or their permissions.
  • Adjusting call handling preferences like enabling/disabling chat, phone, or video calls.
  • Modifying group hours or forcing specific operational states (e.g., force open or closed).
  • Customizing prompts and transcription modes for the group.

For example, an administrator could automate updating a support team's group to disable video calls during certain hours or change the break routing dynamically based on business needs.

Properties

Name Meaning
Id The unique identifier of the group to update. Can be set via expression (e.g., {{$json.Id}}).
Allow Call Service Boolean flag to enable or disable call service for the group.
Answer After Number specifying delay (in seconds) before answering calls.
Break Route JSON object defining routing rules applied during break times.
Break Time JSON object specifying periods considered as break times.
Call Handling Mode JSON array defining how calls are handled by the group (e.g., sequential, simultaneous).
Call Us Enable Chat Boolean to enable or disable chat functionality for incoming calls.
Call Us Enable Phone Boolean to enable or disable phone call functionality.
Call Us Enable Video Boolean to enable or disable video call functionality.
Call Us Requirement Option to specify required caller information: Both (name and email), Name only, Email only, or None.
Click To Call Id String identifier used for click-to-call functionality.
Current Group Hours Option to override current group hours with values like Default, Force Opened, Force Closed, Force Break, Force Custom Operator, Force Holiday, Has Forced Mask.
Custom Operator JSON object defining custom operator tags or settings.
Custom Prompt String to specify a custom prompt message for the group.
Disable Custom Prompt Boolean to enable or disable the custom prompt.
Globally Visible Boolean indicating if the group is visible globally across the system.
Groups JSON array defining nested groups with rights and tags.
Has Members Boolean indicating whether the group has members assigned.
Holidays Route JSON object defining routing rules applied during holidays.
Hours JSON object specifying the group's working hours periods.
Id Number representing the group ID (also sent in the body).
Is Default Boolean indicating if this group is the default group.
Language String specifying the language setting for the group.
Last Login Time String timestamp of the last login time associated with the group.
Members JSON array defining members of the group with their rights and tags.
Name String name of the group.
Number String number associated with the group.
Office Holidays JSON array defining office holiday periods.
Office Route JSON object defining routing rules for office hours.
Out Of Office Route JSON object defining routing rules when out of office.
Override Expires At String timestamp to override expiration time for some group settings.
Override Holidays Boolean to indicate if holiday settings should be overridden.
Prompt Set String specifying the prompt set used by the group.
Props JSON object for additional custom properties.
Rights JSON array defining rights associated with the group.
Time Zone Id String specifying the time zone identifier for the group.
Transcription Mode Option to set transcription mode: Nothing, Voicemail, Recordings, Both, or Inherit.

Output

The node outputs the response from the 3CX API after attempting to update the group. The output is structured as JSON data containing the updated group details or status information returned by the API.

If the API supports binary data (not indicated here), it would typically relate to media files or recordings, but this operation primarily deals with JSON configuration data.

Dependencies

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

Troubleshooting

  • Invalid Group Id: If the specified group ID does not exist, the API will return an error. Verify the ID is correct and accessible.
  • Malformed JSON Properties: Properties like BreakRoute, Hours, Members, etc., expect valid JSON input. Invalid JSON will cause parsing errors. Use proper JSON formatting.
  • Permission Errors: Insufficient API permissions or invalid credentials will result in authorization errors. Ensure the API key or OAuth token has adequate rights.
  • Network Issues: Connectivity problems to the 3CX server will cause request failures. Check network access and server availability.
  • Unsupported Property Values: Some properties have restricted option sets (e.g., CallUsRequirement, TranscriptionMode). Using unsupported values may cause errors.

Links and References

Discussion