ultragroup API

ultragroup模块共 11 个接口。

模块概览​

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

接口列表​

接口方法路径说明幂等
查询超级群的默认免打扰级别POST/im/v2/ultragroup/notdisturb/get查询超级群(或指定频道)的默认免打扰级别:0 全部通知 / 1 仅 @ 通知 / 2 免打扰;未设置返回 0。groupType 必须为 super(否则 1005)。覆盖融云 /ultragroup/notdisturb/get.json。否
设置超级群默认免打扰POST/im/v2/ultragroup/notdisturb/set设置超级群(或频道)默认免打扰,对全体成员生效;scope=all 为群级、scope=channel 需同时传 channelId。覆盖融云 /ultragroup/notdisturb/set.json(兼容 unpushLevel 入参别名)。是
设置/取消超级群全体禁言POST/im/v2/ultragroup/globalbanned/set设置/取消超级群全体禁言(status=true/false,duration 秒可选,缺省为永久);群级状态写入既有 group.mute-all 状态,因此会真实拦截非群主/管理员/白名单成员的发送(1009)。频道级(channelId)仅保存状态。覆盖融云 /ultragroup/globalbanned/set.json。是
查询超级群全体禁言状态POST/im/v2/ultragroup/globalbanned/get查询超级群(或频道)全体禁言状态:status 为当前有效状态(带时长的禁言到期后视为 false),until 为到期时间(0=永久)。覆盖融云 /ultragroup/globalbanned/get.json。否
把用户加入超级群全体禁言白名单POST/im/v2/ultragroup/banned/whitelist/add把用户加入超级群全体禁言白名单(userIds 支持数组或逗号分隔字符串,单次 <=20,幂等,白名单总人数 <=1000);白名单成员在全体禁言期间仍可发送。覆盖融云 /ultragroup/banned/whitelist/add.json。是
把用户移出超级群全体禁言白名单POST/im/v2/ultragroup/banned/whitelist/del把用户移出超级群全体禁言白名单(单次 <=20,幂等;不存在时 removed=0)。覆盖融云 /ultragroup/banned/whitelist/del.json。是
分页查询超级群全体禁言白名单POST/im/v2/ultragroup/banned/whitelist/get分页查询超级群全体禁言白名单(page 从 1 开始,pageSize 默认 50、上限 200;同时返回 users[{id}] 与 userIds)。覆盖融云 /ultragroup/banned/whitelist/get.json。否
禁言指定超级群成员POST/im/v2/ultragroup/userbanned/add禁言指定超级群成员(userIds 单次 <=20,duration 秒可选,缺省永久;群级写入既有成员禁言 Group.muted 并真实拦截发送;单群禁言人数 <=100)。频道级(channelId)仅保存状态。覆盖融云 /ultragroup/userbanned/add.json。是
解除指定超级群成员禁言POST/im/v2/ultragroup/userbanned/del解除指定超级群成员禁言(单次 <=20,幂等;不存在时 removed=0)。覆盖融云 /ultragroup/userbanned/del.json。是
分页查询被禁言的超级群成员POST/im/v2/ultragroup/userbanned/get分页查询被禁言的超级群成员(含 until 到期时间与 permanent 标记;pageSize 默认 50、上限 100)。覆盖融云 /ultragroup/userbanned/get.json。否
查询用户是否为指定超级群成员POST/im/v2/ultragroup/member/exist查询用户是否为指定超级群成员:status=true/false。覆盖融云 /ultragroup/member/exist.json。否

接口约定​

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

相关说明​