群组 API

群组模块覆盖群创建与资料、成员增删与退群/解散、管理员与成员禁言、加入策略、全员禁言白名单、批量导入、群成员资料与特别关注、群备注。

模块概览​

项目值
接口数量28
幂等接口8
路径前缀/im/v2
请求方法POST（JSON 请求体）
鉴权方式App-Key / Nonce / Timestamp / Signature（见 鉴权与签名）
响应信封{ code, msg?, data?, requestId? }

接口列表​

接口方法路径说明幂等
创建群/超级群POST/im/v2/group/create创建群/超级群；groupId 可指定（幂等）或服务端生成。否
更新群信息POST/im/v2/group/update更新群信息（name/notice/avatarUrl）。否
查询群信息POST/im/v2/group/get查询群信息。否
群成员列表POST/im/v2/group/members/list群成员列表。否
批量拉人入群POST/im/v2/group/members/add批量拉人入群。否
批量移除群成员POST/im/v2/group/members/remove批量移除群成员。否
用户退群POST/im/v2/group/quit用户退群（群主需先转让）。否
解散群POST/im/v2/group/dismiss解散群（群主或应用强制）。否
设置群管理员POST/im/v2/group/admin/add设置群管理员（幂等）。是
取消群管理员POST/im/v2/group/admin/remove取消群管理员。是
禁言/解禁群成员POST/im/v2/group/mute禁言/解禁群成员（mutedUntil=0 解禁）。否
加入群POST/im/v2/group/join加入群：公开群/超级群（joinPolicy=open）直接加入；邀请制群需群主/管理员邀请，否则 1003。是
转让群主POST/im/v2/group/transfer转让群主：仅当前群主可操作，目标必须是群成员。否
设置/取消群组全员禁言POST/im/v2/group/mute-all设置/取消群组全员禁言（群主/管理员可操作；白名单成员不受限，覆盖融云 /group/ban/add|rollback）。是
查询群组全员禁言状态POST/im/v2/group/mute-all/get查询群组全员禁言状态（覆盖融云 /group/ban/query）。否
加入群组全体禁言白名单POST/im/v2/group/ban/whitelist/add加入群组全体禁言白名单（白名单成员不受 group.mute 全员禁言限制）。否
移出群组全体禁言白名单POST/im/v2/group/ban/whitelist/remove移出群组全体禁言白名单。否
查询群组全体禁言白名单POST/im/v2/group/ban/whitelist/list查询群组全体禁言白名单。否
批量导入群组POST/im/v2/group/import批量导入群组（上限 50，逐条幂等；返回 imported/failed）。否
设置群成员资料POST/im/v2/group/member/update设置群成员资料（群昵称/扩展字段）。是
设置用户对群成员的特别关注POST/im/v2/group/member/follow/add设置用户对群成员的特别关注（仅本人视角，推送置顶提示）。是
取消对群成员的特别关注POST/im/v2/group/member/follow/remove取消对群成员的特别关注。否
查询用户在该群的特别关注成员列表POST/im/v2/group/member/follow/list查询用户在该群的特别关注成员列表。否
设置用户对群名称的备注名POST/im/v2/group/remark/set设置用户对群名称的备注名（仅本人视角）。是
查询用户对群名称的备注名POST/im/v2/group/remark/get查询用户对群名称的备注名。否
删除用户对群名称的备注名POST/im/v2/group/remark/remove删除用户对群名称的备注名。否
查询群成员禁言列表POST/im/v2/group/user/gag/list查询群成员禁言列表；groupId 省略时返回应用下所有群（items 携带 groupId）。覆盖融云 /group/user/gag/list.json。否
全量同步用户所在群组POST/im/v2/group/sync全量同步用户所在群组：groups 内缺失群自动创建（用户为群主），已存在群幂等加入并可按 name 更新群名；列表外的应用内群移除该用户成员关系（groups 省略表示解绑全部）。覆盖融云 /group/sync.json。是

相关回调事件​

接口约定​

  • 完整请求地址 = 部署域名 + /im/v2 + 接口路径；所有接口使用 POST。
  • 请求头必须携带 App-Key / Nonce / Timestamp / Signature；签名规则见鉴权与签名。
  • 响应统一为 { code, msg?, data?, requestId? }；code = 0 表示成功。
  • 列表类接口使用 limit 分页，单页上限见限频与限制。

相关说明​