超级群 API

超级群模块覆盖加入策略、用户组(创建/删除/成员/按用户查询/绑定频道)以及私有频道(创建/删除/类型/成员/与用户组绑定)。

模块概览​

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

接口列表​

接口方法路径说明幂等
设置超级群加入策略POST/im/v2/supergroup/join-policy/set设置超级群加入策略:invite(默认)/ open。否
创建超级群用户组POST/im/v2/supergroup/usergroup/create创建超级群用户组。否
查询超级群用户组列表POST/im/v2/supergroup/usergroup/list查询超级群用户组列表。否
删除超级群用户组POST/im/v2/supergroup/usergroup/delete删除超级群用户组。否
向用户组添加成员POST/im/v2/supergroup/usergroup/members/add向用户组添加成员。否
从用户组移出成员POST/im/v2/supergroup/usergroup/members/remove从用户组移出成员。否
查询用户所属的用户组POST/im/v2/supergroup/usergroup/by-user查询用户所属的用户组。否
查询用户组绑定的私有频道POST/im/v2/supergroup/usergroup/channels查询用户组绑定的私有频道(同时覆盖融云“查询用户所属私有频道”)。否
创建超级群私有/公开频道POST/im/v2/supergroup/channel/create创建超级群私有/公开频道。否
查询超级群频道列表POST/im/v2/supergroup/channel/list查询超级群频道列表。否
删除超级群频道POST/im/v2/supergroup/channel/delete删除超级群频道。否
变更频道类型POST/im/v2/supergroup/channel/type/set变更频道类型(private/public)。否
添加私有频道成员POST/im/v2/supergroup/channel/members/add添加私有频道成员。否
移除私有频道成员POST/im/v2/supergroup/channel/members/remove移除私有频道成员。否
查询私有频道成员列表POST/im/v2/supergroup/channel/members/list查询私有频道成员列表。否
绑定频道与用户组POST/im/v2/supergroup/channel/usergroup/bind绑定频道与用户组(用户组成员自动获得频道访问)。否
解绑频道与用户组POST/im/v2/supergroup/channel/usergroup/unbind解绑频道与用户组。否
查询频道与用户组的绑定关系POST/im/v2/supergroup/channel/usergroup/list查询频道与用户组的绑定关系(channelId 或 userGroupId 二选一,至少一个)。否

接口约定​

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

相关说明​