3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Update My Group" operation in the "My Group" resource allows users to modify various settings and configurations of a group within the 3CX telephony system. This node is useful for administrators or automation workflows that need to programmatically update group properties such as call handling modes, routing rules, member lists, hours of operation, and other group-specific preferences.

Practical examples include:

  • Automatically updating group call routing based on business hours or holidays.
  • Changing group members or their permissions dynamically.
  • Adjusting call handling features like enabling/disabling chat, phone, or video options.
  • Customizing prompts or transcription settings for specific groups.

Properties

Name Meaning
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 during break periods with associated tags.
Break Time JSON object specifying break time periods for the group.
Call Handling Mode JSON array defining how calls are handled by the group (e.g., forwarding, queueing).
Call Us Enable Chat Boolean to enable or disable chat functionality for the group.
Call Us Enable Phone Boolean to enable or disable phone calling for the group.
Call Us Enable Video Boolean to enable or disable video calling for the group.
Call Us Requirement Option to specify required caller information: Both (name and email), Name only, Email only, None.
Click To Call Id String identifier used for click-to-call functionality.
Current Group Hours Option indicating current group status related to hours: Default, Force Opened/Closed/Break, etc.
Custom Operator JSON object defining custom operator tags for the group.
Custom Prompt String to set 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.
Groups JSON array defining nested groups with rights and tags.
Has Members Boolean indicating if the group currently has members.
Holidays Route JSON object defining routing rules during holidays with associated tags.
Hours JSON object specifying operational hours periods for the group.
Id Numeric identifier of the group to update.
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 for the group.
Members JSON array defining group members with rights and tags.
Name String name of the group.
Number String representing the group's phone number.
Office Holidays JSON array specifying office holiday periods.
Office Route JSON object defining routing rules during office hours with tags.
Out Of Office Route JSON object defining routing rules outside office hours with tags.
Override Expires At String timestamp to override expiration time for some settings.
Override Holidays Boolean to enable or disable overriding holiday settings.
Prompt Set String identifier for a set of prompts used by the group.
Props JSON object for additional custom properties.
Rights JSON array defining rights and permissions for 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 JSON data representing the updated state or response from the 3CX API after performing the update operation on the group. The exact structure depends on the API response but typically includes confirmation of updated fields, status messages, or error details.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The node uses the base URL configured in credentials to send requests to the 3CX API endpoint /xapi/v1.
  • Proper permissions on the 3CX system to update group configurations are necessary.

Troubleshooting

  • Invalid or missing group ID: Ensure the Id property is correctly set to the target group’s numeric identifier.
  • Malformed JSON inputs: Properties like BreakRoute, BreakTime, CallHandlingMode, Groups, Members, etc., expect valid JSON strings. Invalid JSON will cause parsing errors.
  • Permission errors: The API key must have sufficient rights to update group settings; otherwise, the request will fail.
  • Incorrect property values: For options like CallUsRequirement or TranscriptionMode, use only the allowed values to avoid validation errors.
  • Network or authentication issues: Verify the API credentials and network connectivity to the 3CX server.

Links and References

Discussion