调用前需要哪些信息?
准备有效 APIKey 和控制台中的 appid,并按具体接口核对必填字段与附加约束。查看接入流程。
查询群资料,管理成员、群设置与会话。 本页列出此分组全部 25 个 POST 接口。
获取群资料。返回的 roomInfo 只有群号、群名、群主、创建时间等基本字段 —— 不含群公告、不含各项群开关的状态,这些无法通过接口读回。
/qingluan/api/room/getInfo把成员移出群。⚠️ 入参是 userIdList(数组),不是单个 userId。
/qingluan/api/room/delMember拉人进群。⚠️ 入参是 userIdList(数组),不是单个 userId。内部同事与外部联系人都可以拉。
/qingluan/api/room/addMember修改群名称。若群开启了「禁止改群名」则会失败。
/qingluan/api/room/setName获取群二维码。
/qingluan/api/room/getQrCode发布群公告。发布后群内会产生系统消息,可从回调里看到。
/qingluan/api/room/setNotice设置群管理员。
/qingluan/api/room/setAdmin转让群主。
/qingluan/api/room/changeOwner创建客户群。只需 appid。返回 roomId 与入群邀请链接。
/qingluan/api/room/create设置我在本群的昵称。改完可从「获取群资料」的 members[].remark 读回验证。⚠️ 不接受空字符串(返回 code = -1),要清空只能改成别的值或在客户端操作。
/qingluan/api/room/setMyNickname把群保存到通讯录,便于快速查找。
/qingluan/api/room/saveToContact查询我的客户群。注意返回里的 roomId / id 是字符串,回传给其他接口前需转成整数。
/qingluan/api/room/getMyCustomerGroupList会话置顶/取消置顶。作用于整个会话,不是群内消息置顶。
/qingluan/api/room/top退出群聊。
/qingluan/api/room/quit开启/关闭入群确认。⚠️ 该开关的当前状态无法通过任何只读接口读回,需要在企业微信客户端「群设置」里确认。top / saveToContact / forbidMutualAdd / forbidRename / setAdmin 同此。
/qingluan/api/room/inviteConfirm群管理:禁止/允许成员修改群名。enable=true 为禁止。
/qingluan/api/room/forbidRename群管理:禁止/允许群成员之间互相添加好友。
/qingluan/api/room/forbidMutualAdd群主确认受邀入群的成员。
/qingluan/api/room/confirmInvitedMemberList解散群聊,仅群主可用,不可撤销。字段名是小驼峰 roomId。
/qingluan/api/room/disband批量获取群资料。入参是 roomIds(数组) —— 契约里漏标了这个字段。结果在 data.roomInfos,比单个查询多返回群公告、roomKey、客户群类型等字段。
/qingluan/api/room/getInfoBatch增量同步群成员变更。ver 是 base64 字符串不是数字,首次传空字符串取全量,之后回传上次的版本值。结果在 data.roomInfos。
/qingluan/api/room/groupMemberChange查询会话组配置。无需入参,结果在 data.shieldList。
/qingluan/api/room/sessionQueryList配置会话组。入参 roomId —— 契约里漏标了这个字段。
/qingluan/api/room/sessionSet同步会话列表。sync 首次传 0 取全量。返回 sessionList / topList / shieldList 与游标 syncKey。
/qingluan/api/room/sessionSync设置群备注(只影响自己看到的名称,不改群名)。
/qingluan/api/room/setRemark准备有效 APIKey 和控制台中的 appid,并按具体接口核对必填字段与附加约束。查看接入流程。
本组数据面接口返回能力层原始响应。code = 0 表示请求被接受,实际效果及状态应结合接口说明与查询结果确认。