API 接口列表

本页按模块列出 Open API 的全部 230 个接口。所有接口均为 POST，完整路径 = 部署域名 + /im/v2 + 接口路径；请求头与响应格式见 鉴权与签名 与 数据格式。

模块索引​

模块接口数其中幂等回调事件
用户3361
好友关系链84—
黑名单32—
消息3023
群组2883
超级群180—
聊天室35122
会话203—
在线状态10—
敏感词20—
回调配置与投递41—
服务开通21—
运营统计20—
AI 助理代理112—
机器人82—
推送通道71—
sensitiveword44—
statusmessage20—
entrust10—
ultragroup116—

“幂等”列取自 IDL 的 operation.idempotent；未标注表示契约未声明幂等，调用方仍需按业务需要去重。

用户（33 个接口）​

接口方法路径说明幂等
注册用户POST/im/v2/user/register注册用户；userId 幂等（已存在则更新 name/avatarUrl 并返回现有用户）。是
更新用户资料POST/im/v2/user/update更新用户资料。否
查询用户POST/im/v2/user/get查询用户。否
签发用户 JWTPOST/im/v2/user/token/issue签发用户 JWT（供客户端 SDK connect 使用），有效期 7 天。否
查询用户在线状态POST/im/v2/user/online/check查询用户在线状态。否
封禁/解封用户POST/im/v2/user/ban封禁/解封用户；封禁后在线连接被 kick，新连接返回 1016。否
用户私聊白名单POST/im/v2/user/whitelist/add用户私聊白名单：仅白名单用户可给该用户发私聊（空表示不启用）。否
用户私聊白名单POST/im/v2/user/whitelist/remove用户私聊白名单：移除。否
用户私聊白名单POST/im/v2/user/whitelist/list用户私聊白名单：查询。否
主动作废用户全部客户端 tokenPOST/im/v2/user/token/revoke主动作废用户全部客户端 token（tokenVersion++，旧 JWT 立即失效）。否
批量获取用户资料POST/im/v2/user/batch/get批量获取用户资料（上限 100；不存在的 userId 返回在 missing）。否
设置/解除单聊禁言POST/im/v2/user/chat/mute设置/解除单聊禁言（mutedUntil=0 解除；禁言后该用户向目标发私聊返回 1009）。是
查询用户的单聊禁言列表POST/im/v2/user/chat/mute/list查询用户的单聊禁言列表。否
设置用户标签POST/im/v2/user/tag/set设置用户标签（全量覆盖，最多 20 个，每个 ≤32 字符）。是
获取用户标签POST/im/v2/user/tag/get获取用户标签。否
批量设置用户标签POST/im/v2/user/tag/batch/set批量设置用户标签（上限 100 条，返回 updated/failed）。否
获取封禁用户列表POST/im/v2/user/ban/list获取封禁用户列表（分页）。否
删除用户POST/im/v2/user/delete删除用户（开发/测试环境；物理删除用户及其会话关系）。否
清理用户托管资料POST/im/v2/user/profile/clean清理用户托管资料（保留 userId，清空 name/avatarUrl 等自定义字段）。否
设置用户订阅关系POST/im/v2/user/subscription/set设置用户订阅关系（全量覆盖，最多 100 个）。是
查询用户订阅关系POST/im/v2/user/subscription/get查询用户订阅关系。否
注销用户POST/im/v2/user/deactivate注销用户（合规能力：保留记录但禁止登录/收发，踢下线）。否
重新激活已注销用户POST/im/v2/user/reactivate重新激活已注销用户。否
查询已注销用户列表POST/im/v2/user/deactivated/list查询已注销用户列表（分页）。否
设置用户推送免打扰时段POST/im/v2/user/push/period/set设置用户推送免打扰时段（startMinute/endMinute 为当天分钟数 0-1439）。是
查询用户推送免打扰时段POST/im/v2/user/push/period/get查询用户推送免打扰时段。否
删除用户推送免打扰时段POST/im/v2/user/push/period/remove删除用户推送免打扰时段。否
将指定用户踢出其加入的所有群组POST/im/v2/user/group/kick-all将指定用户踢出其加入的所有群组（应用管理员操作）。否
开启用户代聊POST/im/v2/user/proxychat/start开启用户代聊（绑定 Agent，收到私聊时由 Agent 自动回复；回复生成依赖 AI 端点）。覆盖融云 /v3/user/proxychat/start。是
停止用户代聊POST/im/v2/user/proxychat/stop停止用户代聊。覆盖融云 /v3/user/proxychat/stop。否
查询用户代聊列表POST/im/v2/user/proxychat/list查询用户代聊列表（userId 省略返回应用全部）。覆盖融云 /v3/user/proxychat/query。否
接收托管资料审核结果并落库POST/im/v2/user/profile/moderation/sync接收托管资料审核结果并落库（approved/rejected；rejected 可回滚指定资料字段）。覆盖融云 /user/profile/sync。否
查询用户所在的群组POST/im/v2/user/group/query查询用户所在的群组（page/size 分页；page 缺省或 0 返回前 5000 个）。覆盖融云 /user/group/query.json。否

好友关系链（8 个接口）​

接口方法路径说明幂等
直接建立双向好友关系POST/im/v2/friend/add直接建立双向好友关系（应用服务器代操作，不经过申请流程）。是
删除双向好友关系POST/im/v2/friend/remove删除双向好友关系。是
好友列表POST/im/v2/friend/list好友列表。否
检查两人是否为好友关系POST/im/v2/friend/check检查两人是否为好友关系。否
批量清理好友关系POST/im/v2/friend/clean批量清理好友关系（单向/双向）。否
设置添加好友验证等级POST/im/v2/friend/permission/set设置添加好友验证等级（open=无需验证 / verify=需验证 / closed=禁止）。是
查询添加好友验证等级POST/im/v2/friend/permission/get查询添加好友验证等级。否
设置好友自定义属性POST/im/v2/friend/profile/set设置好友自定义属性（备注名/扩展字段，仅本人可见）。是

黑名单（3 个接口）​

接口方法路径说明幂等
加入黑名单POST/im/v2/blacklist/add加入黑名单（幂等）。是
移出黑名单POST/im/v2/blacklist/remove移出黑名单（幂等）。是
黑名单列表POST/im/v2/blacklist/list黑名单列表。否

消息（30 个接口）​

接口方法路径说明幂等
以指定用户身份发送单聊消息POST/im/v2/message/private/publish以指定用户身份发送单聊消息；返回服务端消息（含 seq）。幂等键 clientMsgId。否
发送群/超级群消息POST/im/v2/message/group/publish发送群/超级群消息。否
发送聊天室消息POST/im/v2/message/chatroom/publish发送聊天室消息（仅广播在线成员，不落离线）。否
发送系统通知给一批用户POST/im/v2/message/system/publish发送系统通知给一批用户；落库、离线补发、多端同步，客户端展示为“系统通知”会话。否
撤回消息POST/im/v2/message/recall撤回消息（发送者或应用服务器；时限 recallWindowMs，超时 1022）。否
查询历史消息POST/im/v2/message/history/get查询历史消息（倒序分页，beforeSeq 向前翻页）。否
查询消息已读人数POST/im/v2/message/read/count查询消息已读人数。否
按用户搜索文本消息POST/im/v2/message/search按用户搜索文本消息。否
消息投递轨迹POST/im/v2/message/trace/get消息投递轨迹（存储/ACK/离线补偿/回调路由），控制台消息流转查询使用。否
设置消息扩展 KVPOST/im/v2/message/expansion/set设置消息扩展 KV（key/value，随消息存储；用于业务透传/标记/回应数据）。否
读取消息扩展 KVPOST/im/v2/message/expansion/get读取消息扩展 KV。否
删除消息扩展 KVPOST/im/v2/message/expansion/remove删除消息扩展 KV。否
服务端修改消息内容POST/im/v2/message/modify服务端修改消息内容（单聊/群/超级群统一；仅发送者或应用管理员可改）。修改后历史与拉取返回新内容。否
清除远端会话历史消息POST/im/v2/message/history/clean清除远端会话历史消息（beforeTimestamp 省略表示全部；仅应用管理员/会话参与者可调用）。否
添加消息回应POST/im/v2/message/reaction/add添加消息回应（reaction；同一用户同一表情幂等）。是
移除消息回应POST/im/v2/message/reaction/remove移除消息回应。否
查询消息回应汇总POST/im/v2/message/reaction/list查询消息回应汇总（按表情聚合 count/userIds）。否
查询某表情的回应用户列表POST/im/v2/message/reaction/users查询某表情的回应用户列表。否
批量查询多条消息的回应摘要POST/im/v2/message/reaction/batch批量查询多条消息的回应摘要（上限 50）。否
发送模板消息POST/im/v2/message/template/publish发送模板消息：templateId 指向内置模板，params 填充占位符后按普通消息下发（单聊/群/系统通知）。否
开始流式消息POST/im/v2/message/stream/start开始流式消息（大模型输出场景）：创建流并预分配 messageId，后续 append 追加增量。否
向流追加文本增量POST/im/v2/message/stream/append向流追加文本增量（幂等 seq 可选；重复 seq 覆盖）。否
结束流式消息POST/im/v2/message/stream/end结束流式消息：落库为普通消息并按会话下发（返回最终 Message）。否
获取流内容与状态POST/im/v2/message/stream/get获取流内容与状态（覆盖融云 /message/get_stream）。否
发送全量用户落地通知POST/im/v2/message/broadcast发送全量用户落地通知（写入系统会话并下发；支持指定用户子集）。否
撤回全量用户落地通知POST/im/v2/message/broadcast/recall撤回全量用户落地通知。否
发送在线用户广播POST/im/v2/message/online/broadcast发送在线用户广播（仅推给当前在线连接，不落离线历史）。否
文本翻译POST/im/v2/message/translate文本翻译（转发到应用配置的翻译服务；未配置返回 1021）。覆盖融云 /v3/translate。否
分页查询应用历史消息审计记录POST/im/v2/message/history分页查询应用历史消息审计记录（userId/conversationType/targetId/from/to 过滤；page 从 1 开始，size 上限 100）。审计视图由已持久化消息派生，聊天室等 ephemeral 消息不在范围内。否
按时间区间删除历史消息审计记录POST/im/v2/message/history/delete按时间区间删除历史消息审计记录（from/to 至少传一个，epoch 毫秒闭区间；只记录审计删除区间，不清理在线会话消息存储；重叠区间合并）。是

群组（28 个接口）​

接口方法路径说明幂等
创建群/超级群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。是

超级群（18 个接口）​

接口方法路径说明幂等
设置超级群加入策略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 二选一，至少一个）。否

聊天室（35 个接口）​

接口方法路径说明幂等
创建聊天室POST/im/v2/chatroom/create创建聊天室（幂等：同 chatroomId 已存在则返回现有）。是
销毁聊天室POST/im/v2/chatroom/destroy销毁聊天室：踢出所有在线成员、广播 destroyed。否
聊天室信息POST/im/v2/chatroom/get聊天室信息（含在线数）。否
聊天室在线成员列表POST/im/v2/chatroom/members/list聊天室在线成员列表。否
刷新聊天室空闲销毁时间POST/im/v2/chatroom/keepalive刷新聊天室空闲销毁时间（默认 30 分钟无活动销毁）。否
设置聊天室 KVPOST/im/v2/chatroom/kv/set设置聊天室 KV（房间级键值，随房间销毁；ttlMs 可选）。是
读取聊天室 KVPOST/im/v2/chatroom/kv/get读取聊天室 KV（keys 省略返回全部）。否
删除聊天室 KVPOST/im/v2/chatroom/kv/remove删除聊天室 KV。否
聊天室成员禁言/解禁POST/im/v2/chatroom/mute聊天室成员禁言/解禁（mutedUntil=0 解禁；房主/管理员可操作）。否
聊天室封禁/解封成员POST/im/v2/chatroom/ban聊天室封禁/解封成员（封禁后被踢出且不可再加入）。否
聊天室白名单POST/im/v2/chatroom/whitelist/add聊天室白名单：加入（白名单内用户不受封禁/禁言限制）。否
聊天室白名单POST/im/v2/chatroom/whitelist/remove聊天室白名单：移除。否
聊天室白名单POST/im/v2/chatroom/whitelist/list聊天室白名单：查询。否
设置/取消聊天室全体禁言POST/im/v2/chatroom/mute-all设置/取消聊天室全体禁言（房主/管理员可操作；白名单成员不受限）。是
查询聊天室全体禁言状态POST/im/v2/chatroom/mute-all/get查询聊天室全体禁言状态。否
设置聊天室销毁策略POST/im/v2/chatroom/destroy/policy/set设置聊天室销毁策略（idle=空闲销毁，idleMs 默认 1800000；fixed=定时销毁，destroyAt 由创建时间+idleMs 计算）。否
设置聊天室低优先级消息类型POST/im/v2/chatroom/message/priority/set设置聊天室低优先级消息类型（全量覆盖）。是
查询聊天室低优先级消息类型POST/im/v2/chatroom/message/priority/list查询聊天室低优先级消息类型。否
绑定聊天室与音视频房间POST/im/v2/chatroom/rtc/bind绑定聊天室与音视频房间（RTC 房间号仅存储，音视频能力需外部服务）。是
查询聊天室绑定的音视频房间POST/im/v2/chatroom/rtc/get查询聊天室绑定的音视频房间。否
查询聊天室封禁用户列表POST/im/v2/chatroom/user/block/list查询聊天室封禁用户列表（分页）。覆盖融云 /chatroom/user/block/list.json；time 为解禁时间（UTC），空串表示封禁未设置时长。否
查询应用下已设置保活状态的聊天室列表POST/im/v2/chatroom/keepalive/query查询应用下已设置保活状态的聊天室列表。覆盖融云 /chatroom/keepalive/query.json。否
移除聊天室保活状态并恢复空闲销毁计时POST/im/v2/chatroom/keepalive/remove移除聊天室保活状态并恢复空闲销毁计时。覆盖融云 /chatroom/keepalive/remove.json。是
查询指定用户是否在聊天室中POST/im/v2/chatroom/user/exist查询指定用户是否在聊天室中。覆盖融云 /chatroom/user/exist.json。否
批量查询用户是否在聊天室中POST/im/v2/chatroom/users/exist批量查询用户是否在聊天室中（单次 <=1000；isInChrm 1=在 0=不在）。覆盖融云 /chatroom/users/exist.json。否
查询聊天室禁言用户列表POST/im/v2/chatroom/user/gag/list查询聊天室禁言用户列表（仅返回未到期记录，time 为解禁时间）。覆盖融云 /chatroom/user/gag/list.json。否
全局禁言用户POST/im/v2/chatroom/user/ban/add全局禁言用户：应用下所有聊天室生效，仅约束客户端发送；单次 <=20 用户，minute 1..=43200。覆盖融云 /chatroom/user/ban/add.json。是
解除用户全局禁言POST/im/v2/chatroom/user/ban/remove解除用户全局禁言（单次 <=20 用户；幂等）。覆盖融云 /chatroom/user/ban/remove.json。是
查询应用下已被全局禁言的用户列表POST/im/v2/chatroom/user/ban/query查询应用下已被全局禁言的用户列表（含解禁时间；到期记录惰性清理）。覆盖融云 /chatroom/user/ban/query.json。否
添加消息类型到聊天室消息白名单POST/im/v2/chatroom/whitelist/add.json添加消息类型到聊天室消息白名单（应用级共享，<=20 种，标识 <=32 字符；重复添加幂等）。覆盖融云 /chatroom/whitelist/add.json；路径带 .json 以避开 rev4 用户白名单占用的 /chatroom/whitelist/add。是
查询应用全局的聊天室消息类型白名单POST/im/v2/chatroom/whitelist/query.json查询应用全局的聊天室消息类型白名单。覆盖融云 /chatroom/whitelist/query.json。否
从聊天室消息白名单移除消息类型POST/im/v2/chatroom/whitelist/delete.json从聊天室消息白名单移除消息类型（幂等）。覆盖融云 /chatroom/whitelist/delete.json。是
向应用下所有聊天室广播消息POST/im/v2/message/chatroom/broadcast向应用下所有聊天室广播消息（仅广播当时在线成员，不落聊天室历史；默认不同步发件人）。覆盖融云 /message/chatroom/broadcast.json。否
批量设置聊天室自定义属性POST/im/v2/chatroom/entry/batch/set批量设置聊天室自定义属性（按 entryOwnerId 隔离，单次 <=100 对；同 key 覆盖）。覆盖融云 /chatroom/entry/batch/set.json。是
批量移除聊天室自定义属性POST/im/v2/chatroom/entry/batch/remove批量移除聊天室自定义属性（<=100 个 key，按 entryOwnerId 隔离，幂等）。覆盖融云 /chatroom/entry/batch/remove.json。是

会话（20 个接口）​

接口方法路径说明幂等
用户会话列表POST/im/v2/conversation/list用户会话列表（置顶优先/updatedAt 倒序）。否
设置会话置顶/草稿/提醒级别POST/im/v2/conversation/settings设置会话置顶/草稿/提醒级别（服务端代操作）。否
清空会话未读POST/im/v2/conversation/unread/clear清空会话未读。是
将会话归入标签POST/im/v2/conversation/tag/set将会话归入标签（同一会话可属多个标签，最多 20 个）。是
将会话从标签移除POST/im/v2/conversation/tag/remove将会话从标签移除。否
查询用户的会话标签POST/im/v2/conversation/tag/list查询用户的会话标签（tag 省略返回全部标签及其会话）。否
查询单个会话属性POST/im/v2/conversation/attribute/get查询单个会话属性：置顶、免打扰（notificationLevel/mute）、未读数、草稿、@ 计数、标签与最后一条消息；会话不存在返回缺省值（不创建会话）。覆盖融云 /conversation/attribute/get.json。否
查询用户按会话类型设置的默认通知级别POST/im/v2/conversation/type/notification/get查询用户按会话类型设置的默认通知级别：0 全部通知 / 1 仅 @ / 2 免打扰；未设置返回 0。conversationType 支持 1 单聊 / 2 群 / 3 聊天室 / 6 系统 / 10 超级群。覆盖融云 /conversation/type/notification/get.json。否
设置用户按会话类型的默认通知级别POST/im/v2/conversation/type/notification/set设置用户按会话类型的默认通知级别（0 全部 / 1 仅 @ / 2 免打扰），按 {app}:{user}:{conversationType} 持久化。覆盖融云 /conversation/type/notification/set.json（unpushLevel/isMuted 均可作为入参别名）。是
创建会话标签POST/im/v2/conversation/tag/create创建会话标签：tagName ≤16 字符；tagId 可选（≤32 字符，[A-Za-z0-9_.-]，缺省由 tagName 派生）；单用户最多 20 个标签（超出 1031）。覆盖融云 /conversation/tag/create.json。否
重命名会话标签POST/im/v2/conversation/tag/update重命名会话标签（tagId 不变）。覆盖融云 /conversation/tag/update.json。否
删除会话标签POST/im/v2/conversation/tag/delete删除会话标签，同时清除标签内会话引用；标签不存在返回 1032。覆盖融云 /conversation/tag/delete.json。否
查询用户全部标签POST/im/v2/conversation/tag/get查询用户全部标签（含 conversationCount），按创建顺序返回。覆盖融云 /conversation/tag/get.json。否
把会话加入标签POST/im/v2/conversation/tag/conversations/add把会话加入标签：单次 ≤100 条（items 支持对象数组或 "type:target" 字符串），幂等；单标签最多 1000 个会话（超出 1033）。覆盖融云 /conversation/tag/conversations/add.json。否
把会话移出标签POST/im/v2/conversation/tag/conversations/remove把会话移出标签：单次 ≤100 条，幂等。覆盖融云 /conversation/tag/conversations/remove.json。否
分页查询标签内会话POST/im/v2/conversation/tag/conversations/get分页查询标签内会话（含 top、unreadCount、lastMessageAt；limit 默认 50 上限 200）。覆盖融云 /conversation/tag/conversations/get.json。否
查询某个会话所属标签列表POST/im/v2/conversation/tag/of/conversation查询某个会话所属标签列表。覆盖融云 /conversation/tag/of/conversation.json。否
标签内未读汇总POST/im/v2/conversation/tag/unread/get标签内未读汇总（unreadCount 消息总数 + unreadConversations 有未读的会话数）。覆盖融云 /conversation/tag/unread/get.json。否
标签内置顶/取消置顶会话POST/im/v2/conversation/tag/top/set标签内置顶/取消置顶会话，同时更新会话 is_pinned；会话不在标签内返回 1034。覆盖融云 /conversation/tag/top/set.json。否
删除会话记录POST/im/v2/conversation/delete删除会话记录（列表项/未读/草稿/置顶），历史消息保留；同时从该用户所有标签移除；幂等（removed=false 表示本就不存在）。覆盖融云 /conversation/delete.json。否

在线状态（1 个接口）​

接口方法路径说明幂等
批量在线状态POST/im/v2/presence/batch批量在线状态（<=100）。否

敏感词（2 个接口）​

接口方法路径说明幂等
查询敏感词配置POST/im/v2/sensitive-word/list查询敏感词配置。否
覆盖设置敏感词与处置动作POST/im/v2/sensitive-word/set覆盖设置敏感词（<=500 词，单词 <=64 字符）与处置动作。否

回调配置与投递（4 个接口）​

接口方法路径说明幂等
查询回调配置POST/im/v2/callback/config/get查询回调配置（secret 脱敏）。否
设置回调配置POST/im/v2/callback/config/set设置回调配置：URL、事件订阅、签名密钥、重试策略、启停。是
回调投递日志查询POST/im/v2/callback/delivery/list回调投递日志查询（时间范围/事件类型/状态，分页）。否
手动重试一次失败的回调投递POST/im/v2/callback/delivery/retry手动重试一次失败的回调投递。否

服务开通（2 个接口）​

接口方法路径说明幂等
查询应用服务开通项与配额POST/im/v2/service/activation/get查询应用服务开通项与配额。否
设置应用服务开通项POST/im/v2/service/activation/set设置应用服务开通项（关闭后相关接口返回 1021）。是

运营统计（2 个接口）​

接口方法路径说明幂等
应用维度统计POST/im/v2/stats/app应用维度统计（用户/消息/在线）。否
运营趋势POST/im/v2/stats/trend运营趋势（按天）：DAU/消息量/在线峰值/错误率。否

AI 助理代理（11 个接口）​

接口方法路径说明幂等
创建 AgentPOST/im/v2/agent/create创建 Agent（对话代理配置；对话生成需外部模型接入）。否
获取指定 AgentPOST/im/v2/agent/get获取指定 Agent。否
列出 AgentPOST/im/v2/agent/list列出 Agent（分页）。否
更新 Agent 配置POST/im/v2/agent/update更新 Agent 配置。是
删除 AgentPOST/im/v2/agent/delete删除 Agent。否
设置用户对 Agent 的使用限制POST/im/v2/agent/restriction/set设置用户对 Agent 的使用限制（level=blocked|limited）。是
获取用户 Agent 限制记录POST/im/v2/agent/restriction/get获取用户 Agent 限制记录。否
删除用户 Agent 限制记录POST/im/v2/agent/restriction/remove删除用户 Agent 限制记录。否
查询 Agent 的用户限制列表POST/im/v2/agent/restriction/list查询 Agent 的用户限制列表（分页）。否
Agent 对话生成POST/im/v2/agent/chat/generateAgent 对话生成（转发到应用配置的 AI 服务端点；未配置返回 1021 服务未开通）。覆盖融云 /v3/chat/generate。否
生成回复建议POST/im/v2/agent/chat/suggest生成回复建议（转发到 AI 服务端点；未配置返回 1021）。覆盖融云 /v3/chat/suggest。否

机器人（8 个接口）​

接口方法路径说明幂等
创建机器人账号POST/im/v2/bot/create创建机器人账号（用于自动回复/托管；运行时对话能力需外部模型）。否
获取指定机器人POST/im/v2/bot/get获取指定机器人。否
列出机器人POST/im/v2/bot/list列出机器人（分页）。否
更新机器人资料POST/im/v2/bot/update更新机器人资料。是
删除机器人POST/im/v2/bot/delete删除机器人。否
为已存在的机器人登记 Webhook 回调集成POST/im/v2/v3/bot/integration/create为已存在的机器人（bot.create 产出）登记 Webhook 回调集成：每个机器人一份配置、应用内 <=10 份；events 取 bot.message.private / bot.message.group / bot.message.chatroom / bot.chatroom.user.join。secret 缺省自动生成；回调签名与既有回调一致。覆盖融云 /v3/bot/integration/create.json。否
更新机器人 Webhook 集成POST/im/v2/v3/bot/integration/update更新机器人 Webhook 集成（name / webhookUrl / secret / events / enabled 均可选，只覆盖传入字段）。覆盖融云 /v3/bot/integration/update.json。是
删除机器人 Webhook 集成配置POST/im/v2/v3/bot/integration/delete删除机器人 Webhook 集成配置；配置不存在返回 1001（不静默成功）。覆盖融云 /v3/bot/integration/delete.json。否

推送通道（7 个接口）​

接口方法路径说明幂等
发送推送通知POST/im/v2/push/send发送推送通知（scope=all|tag|package|user|users；不落地，按应用推送配置的 webhook 投递并记录推送日志）。否
查询推送日志POST/im/v2/push/log/list查询推送日志（覆盖融云 /message/push/detail/history）。否
推送聚合统计POST/im/v2/push/stats/day推送聚合统计（按天；覆盖融云 /stat/getDayPushData）。否
单次推送统计POST/im/v2/push/stats/by-id单次推送统计（覆盖融云 /stat/getPushIdData）。否
设置推送备注名POST/im/v2/push/remark/set设置推送备注名（scope=user|group；覆盖融云 /user/remarks/* 与 /group/remarks/*）。是
查询推送备注名POST/im/v2/push/remark/get查询推送备注名。否
删除推送备注名POST/im/v2/push/remark/remove删除推送备注名。否

sensitiveword（4 个接口）​

接口方法路径说明幂等
增量添加敏感词POST/im/v2/sensitiveword/add增量添加敏感词（不覆盖既有词，重复添加幂等；单词 <=32 字符，总数 <=500）。覆盖融云 /sensitiveword/add.json；replaceWord 会把应用处置动作切换为 replace。是
批量增量添加敏感词POST/im/v2/sensitiveword/batch/add批量增量添加敏感词（1..=50 条，合并既有列表，总数 <=500）。words 支持字符串或 {word,replaceWord} 对象。覆盖融云 /sensitiveword/batch/add.json。是
移除单个敏感词POST/im/v2/sensitiveword/delete移除单个敏感词（幂等；不存在时 removed=false）。覆盖融云 /sensitiveword/delete.json。是
批量移除敏感词POST/im/v2/sensitiveword/batch/delete批量移除敏感词（1..=50 条，幂等）。覆盖融云 /sensitiveword/batch/delete.json。是

statusmessage（2 个接口）​

接口方法路径说明幂等
发送单聊状态消息POST/im/v2/statusmessage/private/publish发送单聊状态消息：仅投递当时在线的目标会话，不存储、不计未读、不落离线；离线目标 online=false。服务端下发 WS status 帧。覆盖融云 /statusmessage/private/publish.json。否
发送群聊状态消息POST/im/v2/statusmessage/group/publish发送群聊状态消息：向当时在线的群成员扇出（默认不同步发件人），不存储、不计未读。服务端下发 WS status 帧。覆盖融云 /statusmessage/group/publish.json。否

entrust（1 个接口）​

接口方法路径说明幂等
分页查询用户加入的群POST/im/v2/entrust/joined/group/query分页查询用户加入的群（page/size；role 0=全部/1=成员/2=管理员/3=群主；order 0=正序/1=倒序，默认倒序；size 上限 100）。覆盖融云 /entrust/joined/group/query.json。否

ultragroup（11 个接口）​

接口方法路径说明幂等
查询超级群的默认免打扰级别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。否

统计​

统计项值
接口总数230
模块数20
幂等接口数54
声明回调事件的接口数16
错误码数43
回调事件数22

相关说明​