青鸾QINGLUAN
控制台
GROUPS / API REFERENCE

群聊 API

25个接口

查询群资料,管理成员、群设置与会话。 本页列出此分组全部 25 个 POST 接口。

全部接口

获取群资料

获取群资料。返回的 roomInfo 只有群号、群名、群主、创建时间等基本字段 —— 不含群公告、不含各项群开关的状态,这些无法通过接口读回。

POST/qingluan/api/room/getInfo

移除群成员

把成员移出群。⚠️ 入参是 userIdList(数组),不是单个 userId。

POST/qingluan/api/room/delMember

添加群成员

拉人进群。⚠️ 入参是 userIdList(数组),不是单个 userId。内部同事与外部联系人都可以拉。

POST/qingluan/api/room/addMember

修改群名

修改群名称。若群开启了「禁止改群名」则会失败。

POST/qingluan/api/room/setName

获取群二维码

获取群二维码。

POST/qingluan/api/room/getQrCode

发布群公告

发布群公告。发布后群内会产生系统消息,可从回调里看到。

POST/qingluan/api/room/setNotice

设置/取消群管理员

设置群管理员。

POST/qingluan/api/room/setAdmin

转让群主

转让群主。

POST/qingluan/api/room/changeOwner

创建群聊

创建客户群。只需 appid。返回 roomId 与入群邀请链接。

POST/qingluan/api/room/create

修改我的群昵称

设置我在本群的昵称。改完可从「获取群资料」的 members[].remark 读回验证。⚠️ 不接受空字符串(返回 code = -1),要清空只能改成别的值或在客户端操作。

POST/qingluan/api/room/setMyNickname

群聊保存到通讯录

把群保存到通讯录,便于快速查找。

POST/qingluan/api/room/saveToContact

查询我的客户群

查询我的客户群。注意返回里的 roomId / id 是字符串,回传给其他接口前需转成整数。

POST/qingluan/api/room/getMyCustomerGroupList

置顶/取消置顶群聊

会话置顶/取消置顶。作用于整个会话,不是群内消息置顶。

POST/qingluan/api/room/top

退出群聊

退出群聊。

POST/qingluan/api/room/quit

开启/关闭入群确认

开启/关闭入群确认。⚠️ 该开关的当前状态无法通过任何只读接口读回,需要在企业微信客户端「群设置」里确认。top / saveToContact / forbidMutualAdd / forbidRename / setAdmin 同此。

POST/qingluan/api/room/inviteConfirm

禁止/允许成员改群名

群管理:禁止/允许成员修改群名。enable=true 为禁止。

POST/qingluan/api/room/forbidRename

禁止/允许群内互加

群管理:禁止/允许群成员之间互相添加好友。

POST/qingluan/api/room/forbidMutualAdd

确认受邀入群成员

群主确认受邀入群的成员。

POST/qingluan/api/room/confirmInvitedMemberList

解散群聊

解散群聊,仅群主可用,不可撤销。字段名是小驼峰 roomId。

POST/qingluan/api/room/disband

批量获取群资料

批量获取群资料。入参是 roomIds(数组) —— 契约里漏标了这个字段。结果在 data.roomInfos,比单个查询多返回群公告、roomKey、客户群类型等字段。

POST/qingluan/api/room/getInfoBatch

同步群成员变更

增量同步群成员变更。ver 是 base64 字符串不是数字,首次传空字符串取全量,之后回传上次的版本值。结果在 data.roomInfos。

POST/qingluan/api/room/groupMemberChange

查询会话组

查询会话组配置。无需入参,结果在 data.shieldList。

POST/qingluan/api/room/sessionQueryList

配置会话组

配置会话组。入参 roomId —— 契约里漏标了这个字段。

POST/qingluan/api/room/sessionSet

同步会话列表

同步会话列表。sync 首次传 0 取全量。返回 sessionList / topList / shieldList 与游标 syncKey。

POST/qingluan/api/room/sessionSync

设置群备注

设置群备注(只影响自己看到的名称,不改群名)。

POST/qingluan/api/room/setRemark

接入常见问题

调用前需要哪些信息?

准备有效 APIKey 和控制台中的 appid,并按具体接口核对必填字段与附加约束。查看接入流程

如何理解返回结果?

本组数据面接口返回能力层原始响应。code = 0 表示请求被接受,实际效果及状态应结合接口说明与查询结果确认。

搜索接口

输入关键词查找接口。最多显示 20 项。