Skip to content

群 ​

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

本模块接口全部 POST。{BASE_URL} 是含 /wx-api 的完整 API Base;直接复制接口页的请求示例。

接口用途安全级别
获取群资料
/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
给群设置备注,只对当前账号生效,不会改群名。写操作

安全级别与「实测 日期」标记的含义见API 参考的表格说明。

先拿到 roomId ​

除了创建客户群,群接口几乎都要传 roomId(群会话 ID,int64)。从获取我的客户群列表拿:data.roomData.list[].roomId;推送和会话里带的 roomId 也可以直接用。

不要用错 ID

列表项里还有一个更长的 id(19 位),那是客户群记录的 ID,不是 roomId。做群操作一律用 roomId。

谁能操作 ​

操作需要的身份
设置管理员、转让群主、解散群聊、开启 / 关闭入群确认、禁止成员改群名、禁止群成员互加好友当前账号是群主;其中部分开关管理员也能操作,以客服说明为准
移除群成员、设置群名、修改群公告一般群主或管理员可以;普通成员受「禁止成员改群名」等开关限制

身份不满足时,接口返回失败码。

返回什么 ​

  • 除了创建客户群,群的写操作成功时只返回 code、detail、message、time,没有 data。判断成功只看 code 是否为 0。
  • 创建客户群只需传 appid,会建一个空群,返回邀请链接 url、title、content、默认群头像 imgUrl 和新群的 roomId。建好后用添加群成员拉人。
  • 获取群二维码返回二维码图片的 base64 roomQrcode(PNG 图片,不是链接)、群头像 imgUrl 和 roomId。显示二维码时加上 data:image/png;base64, 前缀。
  • 错误码 -18000059 表示群二维码已停用。

会收到哪些推送 ​

接口发出的普通消息不会推送,但群资料和群成员变化会推系统消息。最常见的两种:

  • 2118:群信息变化。最频繁,一次操作可能推多条,按 roomId 刷新群资料即可。
  • 1006:建群或群成员变化。hex 解码后是用分号分隔的成员 uin,收到后刷新群成员。

完整列表见回调字典 · 类型速查表。