群组管理

最近更新时间：2024-04-26 11:29:32

我的收藏

本页目录：

群组资料管理
群成员/群组管理

即时通信 IM 根据常见使用场景，默认配置了以下群组形态：好友工作群（Work）、陌生人社交群（Public）、临时会议群（Meeting）、直播群（AVChatRoom）和社群（Community），详细请参阅 群组类型介绍。
针对群组，可进行以下操作：
群组操作
说明
备注
创建群组
创建一个新的群组，可指定群组类型、群组名称以及要加入的用户列表，创建成功后返回群组 ID；群组 ID 为群组唯一识别标识，可通过群组 ID 进行收发消息等其他群组操作。
每个 App 每天净消耗群组上限为10000个。
转让群组
更换群主身份给他人。
App 管理员可以通过 REST API 转让群组，除此之外只有群主可以转让群组。
解散群组
解散 App 上创建的某个群组，群组被解散时，群组原有成员均会收到解散群组的系统消息。
App 管理员可调用 REST API 接口解散任意群组。在App端解散群组权限受成员角色限制，陌生人社交群（Public）、临时会议群（Meeting）、直播群（AVChatRoom）、社群（Community）只有群主可以解散群组；
好友工作群（Work）群内任何人都无法解散群组。
注意
创建群组时，即时通信 IM 会分配默认群组 ID，该群组 ID 以@TGS# 开头。但也支持用户指定群组 ID，详情请参阅 自定义群组 ID。
创建群组之后，群主所在终端会收到创建群组系统消息，目的在于保持多终端群组同步（一个终端创建群组之后，所有终端都能立即感知到该群已被创建）。
群组资料管理
群组资料是指单个群组维度的属性，包括群组名称、简介、公告、群主等，以及群组维度自定义字段。
群资料管理
说明
备注
获取群组资料
拉取群组的基本资料，如果想拉取自定义资料，可通过设置拉取字段的接口进行设置。
群成员获取群组资料：成员获取本群组资料。
非群成员获取群组资料：非群成员获取群组资料只能获取公开信息。
获取本人在群里的资料：可以获取本人在所有群内的资料，也可以获取单个群内本人在群里的资料。
获取群内某个人的资料：直播群（AVChatRoom）不存储群成员资料信息，不支持获取群成员的个人资料。
修改群组资料
可修改群组名称、群组简介、群组公告、群组头像、群名片，修改加群选项、群组维度自定义字段、用户群内身份、群成员维度自定义字段和接收群消息选项等信息。
目前 App 可以在控制台上自助配置群名称、简介、公告、头像 URL 的变更回调。如果需要启用其他群资料（包括群维度的自定义字段）的变更回调，请 提工单 申请。
群成员/群组管理
群成员管理包括以下两个方面：
获取/修改自己在群组中的信息，这些信息仅仅可以由用户自己获取/设置，例如消息接收选项等。
获取/修改其他群成员的信息，包括群成员的身份、入群时间、最后发消息时间、群名片以及群成员维度的自定义资料。
群成员管理
说明
备注
获取群成员资料
获取自己或其他群成员的信息。
可获取群成员的身份、入群时间、最后发消息时间、群名片，以及群成员维度的自定义资料。
修改群成员资料
群主、管理员或成员均可修改相应的群成员资料。
群主或者管理员修改其他群成员的资料，包括修改群内身份（设置/取消管理员）、禁言、修改群名片、群成员维度的自定义字段等。
群成员主动修改自己在群内的资料，包括消息接收选项、群名片、群成员维度的自定义字段等。
邀请加群
邀请加群是希望将其他用户拉入某一群组中。
好友工作群（Work）中，任何群成员都可以邀请他人入群， 且无需被邀请人同意直接加入群中。
陌生人社交群（Public）和临时会议群（Meeting）默认只有 App 管理员能够邀请其他用户加群。
直播群 (AVChatRoom) 则不允许任何人邀请他人加群。
社群（Community）中，任何群成员都可以邀请他人入群， 且无需被邀请人同意直接加入群中。
申请加群
申请加群即用户通过 IM SDK 主动加入某一群组的动作。
好友工作群（Work）不允许申请加群，会直接返回错误。
社群（Community）申请加群默认情况下无需审批直接进群，如需进群审批，可通过群资料中的 ApplyJoinOption 字段控制。
对于其他内置群组类型，申请加群的处理结果，由群资料中的 ApplyJoinOption 字段决定的。
删除群组成员
删除群组成员是群主或者群管理员将群成员从群组中移除的操作。
当管理员或群主将用户从群组中删除之后，被删除的用户会收到被移出群组的系统消息，群内其他成员也会收到该用户被移出群组的事件消息。
主动退群
主动退群是群内成员主动发起退群操作。
群成员主动退群之后，主动发起退群操作的用户会收到主动退群系统消息，群内其他成员会收到该成员退出群组的事件消息。
获取用户所加入的群组
拉取当前用户加入的所有群组列表，返回的信息只包含部分基本信息。
详细群组信息可以根据群成员获取群组资料功能进行获取。
群未决信息列表
群组未决信息泛指所有需要审批的群相关的操作。
可拉取群未决列表、上报群未决已读、处理群未决信息（同意或拒绝）；单个用户未决列表最多保存50个。
?

群组操作	说明	备注
创建群组	创建一个新的群组，可指定群组类型、群组名称以及要加入的用户列表，创建成功后返回群组 ID；群组 ID 为群组唯一识别标识，可通过群组 ID 进行收发消息等其他群组操作。	每个 App 每天净消耗群组上限为10000个。
转让群组	更换群主身份给他人。	App 管理员可以通过 REST API 转让群组，除此之外只有群主可以转让群组。
解散群组	解散 App 上创建的某个群组，群组被解散时，群组原有成员均会收到解散群组的系统消息。	App 管理员可调用 REST API 接口解散任意群组。在App端解散群组权限受成员角色限制，陌生人社交群（Public）、临时会议群（Meeting）、直播群（AVChatRoom）、社群（Community）只有群主可以解散群组；好友工作群（Work）群内任何人都无法解散群组。

群资料管理	说明	备注
获取群组资料	拉取群组的基本资料，如果想拉取自定义资料，可通过设置拉取字段的接口进行设置。	群成员获取群组资料：成员获取本群组资料。非群成员获取群组资料：非群成员获取群组资料只能获取公开信息。获取本人在群里的资料：可以获取本人在所有群内的资料，也可以获取单个群内本人在群里的资料。获取群内某个人的资料：直播群（AVChatRoom）不存储群成员资料信息，不支持获取群成员的个人资料。
修改群组资料	可修改群组名称、群组简介、群组公告、群组头像、群名片，修改加群选项、群组维度自定义字段、用户群内身份、群成员维度自定义字段和接收群消息选项等信息。	目前 App 可以在控制台上自助配置群名称、简介、公告、头像 URL 的变更回调。如果需要启用其他群资料（包括群维度的自定义字段）的变更回调，请提工单申请。

群成员管理	说明	备注
获取群成员资料	获取自己或其他群成员的信息。	可获取群成员的身份、入群时间、最后发消息时间、群名片，以及群成员维度的自定义资料。
修改群成员资料	群主、管理员或成员均可修改相应的群成员资料。	群主或者管理员修改其他群成员的资料，包括修改群内身份（设置/取消管理员）、禁言、修改群名片、群成员维度的自定义字段等。群成员主动修改自己在群内的资料，包括消息接收选项、群名片、群成员维度的自定义字段等。
邀请加群	邀请加群是希望将其他用户拉入某一群组中。	好友工作群（Work）中，任何群成员都可以邀请他人入群，且无需被邀请人同意直接加入群中。陌生人社交群（Public）和临时会议群（Meeting）默认只有 App 管理员能够邀请其他用户加群。直播群 (AVChatRoom) 则不允许任何人邀请他人加群。社群（Community）中，任何群成员都可以邀请他人入群，且无需被邀请人同意直接加入群中。
申请加群	申请加群即用户通过 IM SDK 主动加入某一群组的动作。	好友工作群（Work）不允许申请加群，会直接返回错误。社群（Community）申请加群默认情况下无需审批直接进群，如需进群审批，可通过群资料中的 ApplyJoinOption 字段控制。对于其他内置群组类型，申请加群的处理结果，由群资料中的 ApplyJoinOption 字段决定的。
删除群组成员	删除群组成员是群主或者群管理员将群成员从群组中移除的操作。	当管理员或群主将用户从群组中删除之后，被删除的用户会收到被移出群组的系统消息，群内其他成员也会收到该用户被移出群组的事件消息。
主动退群	主动退群是群内成员主动发起退群操作。	群成员主动退群之后，主动发起退群操作的用户会收到主动退群系统消息，群内其他成员会收到该成员退出群组的事件消息。
获取用户所加入的群组	拉取当前用户加入的所有群组列表，返回的信息只包含部分基本信息。	详细群组信息可以根据群成员获取群组资料功能进行获取。
群未决信息列表	群组未决信息泛指所有需要审批的群相关的操作。	可拉取群未决列表、上报群未决已读、处理群未决信息（同意或拒绝）；单个用户未决列表最多保存50个。