青鸾QINGLUAN
控制台

查询我的客户群

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

POST/qingluan/api/room/getMyCustomerGroupList

接口说明

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

请求参数

请求体必填。通过 QL-Key 请求头携带 APIKey。

Content-Type:application/json

请求参数。字段名区分大小写,请按文档原样传递。

appidstring必填

青鸾实例 ID,形如 we_xxxxxxxxxxxxxxx。在开发者控制台「实例与回调」扫码上号后获得。

字段示例:"we_xxxxxxxxxxxxxxx"
limitint64必填

分页大小

单页条数。

最小值:1 字段示例:2000

响应与结果确认

本接口为能力层原样返回,不统一增加青鸾外层信封。code = 0 仅表示请求被接受,不保证副作用已完成。

仅对查询接口可读的群资料,用获取群资料核对;部分设置开关需要在企业微信客户端确认,具体以本页说明为准。

响应字段与 HTTP 状态

HTTP 200

能力层原样返回;code = 0 仅表示请求已受理,业务结果须按接口说明确认。

application/json

查看响应字段定义

接口原样返回平台的业务响应。HTTP 状态码与业务状态码需分别判断:HTTP 200 只表示请求已送达,成功以 code = 0 为准。

codeinteger必填

业务状态码

业务状态码:0 表示成功,-1 表示失败;失败原因见 message

字段示例:0
dataobject可选

业务数据

业务返回数据;字段结构见下方定义。

roomDataobject可选

群数据集合

listobject[]可选

数据列表

数组元素 · object

idint64可选

对象 ID。发消息返回时即 serverMsgId(撤回要用);上传返回时即 fileId(发送/下载要用);列表项中为该条记录 ID

roomIdint64可选

群聊 ID

群聊 ID。可从创建群、群列表、群详情或回调事件中获取。

ownerVidint64可选

群主 vid

createTsint64可选

群聊创建时间,Unix 时间戳(秒)。

updateTsint64可选

群聊最近更新时间,Unix 时间戳(秒)。

memberCountint64可选

成员数

flagint64可选

状态标志位(按位含义见平台文档)

roomNamestring可选

群名称

roomUrlstring可选

群头像 URL

shiftTimeint64可选

群聊迁移或状态切换时间,Unix 时间戳(秒);无记录时通常为 0。

oldOwnerVidint64可选

原群主 vid

isCannotOnJobSucceedboolean可选

是否存在无法完成在职继承的状态。

nextStartint64可选

下页起始游标,-1 表示无更多

注意:单页取完时为 -1。翻页语义(是否作为下一页入参)未确认。

totalCountint64可选

总条数

detailstring可选

错误详情

错误详情;无补充信息时通常为空字符串。

messagestring必填

响应消息

业务结果消息。成功通常为 ok;企微错误通常为 错误码|错误信息

字段示例:"ok"
timestring必填

服务端时间

服务端时间,格式为 YYYY-MM-DD HH:mm:ss

字段示例:"2026-07-21 07:33:17"

HTTP 403

受控接口,需通过控制台配置

HTTP 404

appid 不存在或无权访问

搜索接口

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