3CX icon

3CX

Interact with 3CX telephony system
Join our community

Actions462

Overview

The "Create Group" operation in the Groups resource allows users to create a new group within the 3CX telephony system. This node is useful for managing call routing, permissions, and group-specific settings in an organization’s phone system. It enables automation of group creation with detailed configuration such as call handling modes, hours of operation, member assignments, and custom prompts.

Practical examples include:

  • Automatically creating support or sales groups with predefined call routing and member rights.
  • Setting up groups with specific business hours and holiday schedules.
  • Configuring groups to enable or disable chat, phone, or video communication channels.

Properties

Name Meaning
Allow Call Service Enable or disable the call service for the group (boolean).
Answer After Number of seconds to wait before answering a call (number).
Break Route JSON object defining routing rules during break times.
Break Time JSON object specifying periods considered as breaks.
Call Handling Mode JSON array defining how calls are handled by the group.
Call Us Enable Chat Enable or disable chat functionality for the group (boolean).
Call Us Enable Phone Enable or disable phone functionality for the group (boolean).
Call Us Enable Video Enable or disable video functionality for the group (boolean).
Call Us Requirement Requirement for caller information: Both, Name, Email, or None.
Click To Call Id Identifier string for click-to-call feature.
Current Group Hours Status of group hours, options include Default, Force Opened, Force Closed, Force Break, etc.
Custom Operator JSON object defining custom operator tags.
Custom Prompt String to specify a custom prompt message.
Disable Custom Prompt Boolean to 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 has members.
Holidays Route JSON object defining routing rules during holidays.
Hours JSON object specifying operational periods/hours.
Id Numeric identifier for the group.
Is Default Boolean indicating if this group is the default group.
Language String specifying the language setting for the group.
Last Login Time String representing the last login time.
Members JSON array defining members with rights and tags.
Name Name of the group (string).
Number Phone number associated with the group (string).
Office Holidays JSON array specifying office holiday dates.
Office Route JSON object defining routing rules during office hours.
Out Of Office Route JSON object defining routing rules outside office hours.
Override Expires At String date/time to override expiration.
Override Holidays Boolean to override holiday settings.
Prompt Set String specifying a set of prompts to use.
Props JSON object for additional properties.
Rights JSON array defining rights assigned to the group.
Time Zone Id String specifying the time zone ID for the group.
Transcription Mode Option for transcription: Nothing, Voicemail, Recordings, Both, or Inherit.

Output

The node outputs JSON data representing the created group object as returned by the 3CX API. This includes all configured properties such as group ID, name, members, routing rules, and other settings. The output does not explicitly mention binary data, so it is assumed to be purely JSON structured data describing the group.

Dependencies

  • Requires an API key credential for authenticating with the 3CX telephony system.
  • The base URL for the 3CX API must be configured in the node credentials.
  • The node uses the 3CX REST API v1 endpoints under /xapi/v1.

Troubleshooting

  • Invalid JSON input: Many properties expect JSON strings that are parsed before sending. Ensure valid JSON syntax to avoid parsing errors.
  • Authentication errors: Verify that the API key or OAuth2 token is correctly configured and has sufficient permissions.
  • Missing required fields: Some fields like Name or Number might be mandatory; ensure they are provided.
  • Incorrect routing configurations: Misconfigured routing objects (e.g., BreakRoute, OfficeRoute) may cause unexpected call behavior.
  • Time zone and hours mismatch: Ensure TimeZoneId matches the format expected by 3CX and that hours periods are correctly defined.

Links and References

Discussion