Skip to content

建群、资料、成员、群管理开关、退群与解散。

本模块接口全部 POST,请求地址 = {BASE_URL} + 路径。

接口用途安全级别
获取群资料
/wx-api/api/room/getInfo
查询单个群的资料——群名、群主、建群时间、成员列表(vid / 入群时间 / 邀请人 / 备注等)。只读
移除群成员
/wx-api/api/room/delMember
把一个或多个成员移出群(踢人)。高风险
添加群成员
/wx-api/api/room/addMember
邀请一个或多个用户进群(拉人入群)。写操作
设置群名
/wx-api/api/room/setName
修改群名称。写操作
获取群二维码
/wx-api/api/room/getQrCode
获取群的入群二维码(返回二维码图片 base64 + 群头像 url)。只读
修改群公告
/wx-api/api/room/setNotice
设置 / 修改群公告文本。写操作
设置管理员
/wx-api/api/room/setAdmin
把某成员设为群管理员,或取消其管理员身份。写操作
转让群主
/wx-api/api/room/changeOwner
把群主身份转让给另一名成员。高风险
创建客户群
/wx-api/api/room/create
创建一个新的(空)客户群,返回新群 roomId 与邀请卡片信息;随后用 addMember 拉人。写操作
修改我在群内的昵称
/wx-api/api/room/setMyNickname
修改「我」在指定群里的群昵称(仅影响本号在该群的显示名)。写操作
保存通讯录(仅限群)
/wx-api/api/room/saveToContact
把群「保存到通讯录 / 从通讯录移除」(开关)。写操作
获取我的客户群列表
/wx-api/api/room/getMyCustomerGroupList
分页拉取本号名下的客户群列表(获取 roomId 的主入口)。只读
会话置顶 / 取消置顶
/wx-api/api/room/top
把会话(群或联系人)置顶或取消置顶。写操作
退出群聊
/wx-api/api/room/quit
本号主动退出某个群。高风险
开启 / 关闭入群确认
/wx-api/api/room/inviteConfirm
开启 / 关闭「入群邀请需群主确认」。写操作
禁止改群名(群管理)
/wx-api/api/room/forbidRename
开启 / 关闭「仅群主可修改群名」(禁止普通成员改群名)。写操作
禁止添加群成员(群管理)
/wx-api/api/room/forbidMutualAdd
开启 / 关闭「禁止群成员互相添加好友 / 互相拉人」。写操作
解散群聊(群主)
/wx-api/api/room/disband
群主解散整个群(所有成员被移出,群不复存在)。高风险
设置群备注
/wx-api/api/room/setRemark
给群设置备注(本号视角的群备注,不改群名)。写操作

安全级别与「实测 日期」标记的含义见接口总览的图例

群操作调用流程

  1. 先拿 roomId:除 create(建新群)外,几乎所有群接口都要 roomId(群会话 id,int64)。来源是 getMyCustomerGroupList(我的客户群列表)——先拉列表,拿到 data.roomData.list[].roomId,再以它为准做后续操作;也可从会话 / 回调里带出来的 roomId 复用。
    • 注意:列表项还有一个更长的 id(19 位雪花 id),那是客户群记录 id,与 roomId(群会话 id)不是同一个值;做群操作一律用 roomId
  2. 权限前置:群管理类操作对本号身份有要求——setAdmin / changeOwner / disband / inviteConfirm / forbidRename / forbidMutualAdd 需本号是群主(部分开关群主 / 管理员皆可,具体以对接人说明为准);delMembersetNamesetNotice 一般群主 / 管理员可做,普通成员受「禁改群名」等开关限制。本号不满足身份时接口会回失败码。
  3. 群操作会产生大量回调消息(见回调字典 · 类型速查表)。经接口发的普通消息不推回调,但群结构 / 设置变更会推系统消息,高频的几条:
    • 2118 群信息变动,频率最高,一次操作可带出多条,按 roomId 刷新群资料即可;
    • 1006 群成员 / 建群相关,hex 解出为分号连接的成员 uin,收到后刷新群成员。

写操作响应

创建群聊外,群分类写 / 破坏性接口的成功响应都是裸封套 {code:0, detail, message, time}——无 data 字段;判断成功只看 code:0,不能读 data.status

create 是唯一带 data 的写接口:data = {url(邀请链接), title, content, imgUrl(默认群头像), roomId};body 只需 appid 即可建一个空群。

getQrCode 返回 roomQrcode(PNG base64 图片字节)、imgUrl(群头像 url)与 roomIdroomQrcode 渲染时加 data:image/png;base64, 前缀。

错误码

-18000059 表示群二维码被停用。