Documentation
Instant Messaging
English
Getting StartedResourcesConceptsQuickstartGuidesClient APIsServer APIs
WhatsApp
Windows/macOS
Overview
Integrate the SDK
Initialization
Recent Chats
Event Subscription
System Notification
Overview
Manage Built-in System Notifications
Unread System Notifications
Custom System Notifications
Group
Overview
Manage Groups
Group Members
Group Messages
Audio Recording and Playback
NOS Storage
Document Conversion
Reference Documents
Instructions for Upgrading
Development Example
Windows UI Library Tutorial
Description of class and constant definitions
DocumentationInstant MessagingGuidesOverview

Overview

Update time: 2023/03/23 09:57:13

NIM SDK allows you to create standard groups and advanced groups.

The standard group is deprecated, and the SDK does not support the creation and use of standard groups. Only advanced groups are available. The group concepts are related to advanced groups.

Advanced groups has a complete member permission system and management functionalities. All members the group are categorized into group owners, administrators, and group members by permission.

Features

Advanced groups have the following features:

Feature Description
Group capacity IM Pro supports 200 people/group. You can extend the capacity up to 5000 people/group.
Create groups You can create advanced groups. One account can create up to 100 groups (50 groups/account for the free tier). 5,000 groups/user is supported (Add-on)）
Dismissed groups are not counted.
Group profile Group name, avatar, description, announcement, and extension fields.
The verification mode for requests to join a group, the inviter mode, the invitee mode.
Group profile edit permissions, group extension fields edit permissions, and all mute mode
Invitation Options for this setting: only admins can invite or everyone can invite.
Approval mode Options: Approval is required or not required by invitees
Request to join a group A user can join 5000 groups.
Verification Options: approval by admins required or not required; Do not approve all requests.
Member types Group owner, admin, regular member.
Admin settings Group owner can assign or revoke administrator roles.
Edit permission for group profiles Options: Only admins can edit the group profile; All group members can edit the group profile.
Edit the nickname of a group member Only the group owner can edits the nickname of all members
Edit the nickname of the current user Supported
Message types Include basic message types
Notification alert Enable alerts; only admins can receive alerts; disable alerts.
Message history Support cloud-based message history. IM Pro allows users to get the message history for the last year
A maximum of up to 3 years of message history can be retrieved.
offline messages Up to 100 offline messages per group chat can be delivered.
Roaming messages Automatic roaming for 7 days, the most recent 100 messages for each conversation
Force push for specified members Supported
Removing members Group owners or admins can remove one or more members from a group. Admins cannot remove group owners or other admins from a group.
Leaving a group Except the group owner, all other members can leave a group.
A group owner can transfer the ownership of a group to one of group members and leave the group.
Mute members The group owner can mute or unmute group members
Options: mute all members including the group owner and administrators, or only ordinary members.
Transfer the ownership of a group The group owner can transfer the ownership of a group to other members in the group.The member granted the ownership becomes the new group owner, and the original group owner becomes a regular member.
. The original group owner can transfer the group and leave the group directly.
Dismissing a group The group owner can dismiss a group
Read receipt for group messages View the read receipt for a group message (add-on feature)
Read receipt for group messages is supported by groups with members less than 100 people. If a group has more than 100 members, the read receipt is not supprted.

Group object

  • For information about the parameters of a group object, see Group information JSON Keys. Parameters:

    • Join mode kNIMTeamInfoKeyJoinMode: Whether authentication is required to join a group, enumeration type: NIMTeamJoinMode.
    • Invite permission kNIMTeamInfoKeyInviteMode: The permission to invite users to join a group. For the permission types, see NIMTeamInviteMode
    • Consent types kNIMTeamInfoKeyBeInviteMode: Whether the consent of the invited is required. For the enumeration, see NIMTeamBeInviteMode
    • Edit permission of group attributes kNIMTeamInfoKeyUpdateInfoMode: What role of members can edit the group attributes. Enum types:NIMTeamUpdateInfoMode
    • Edit permission of custom group attributes kNIMTeamInfoKeyUpdateCustomMode: What role of members can edit the custom attributes. Enum types: NIMTeamUpdateCustomMode
    • Mute types kNIMTeamInfoKeyMuteType: The mute scope, enum types: NIMTeamMuteType
    • Custom extension field for the app serverkNIMTeamInfoKeyServerCustom: This parameter is configured by the server API and read-only to clients.
    • Custom extension field kNIMTeamInfoKeyCustom: Clients can set, store and transparently transmit this parameter.

  • For information about group member profiles, see Group member profile JSON Keys. Parameters:

Groups API Overview

C++

The nim::Team class provides interfaces for group operations and allows you to manage groups.

C

The nim_team header file defines methods for group operations and allows you to manage groups.

WhatsApp
Was this page helpful?
Yes
No
  • Features
  • Group object
  • Groups API Overview