青鸾QINGLUAN
控制台

查询待发群发

获取待发送的群发任务列表。返回的 list[].id 供 groupSendPending 使用。

POST/qingluan/api/message/getPendingGroupSendList

接口说明

获取待发送的群发任务列表。返回的 list[].id 供 groupSendPending 使用。

:::tip 🔗 调用关系

获取待发送列表 → 读取任务 id → 调用 groupSendPending。 :::

:::check ✅ 成功判定:HTTP 200 且响应体 code = 0。业务失败请查看 messagedetail。 :::

请求参数

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

Content-Type:application/json

appidstring必填

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

字段示例:"we_xxxxxxxxxxxxxxx"

响应与结果确认

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

请结合业务数据与本页说明判断实际状态,不要仅凭响应码推断操作效果。

响应字段与 HTTP 状态

HTTP 200

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

application/json

查看响应字段定义

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

codeinteger必填

业务状态码

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

字段示例:0
dataobject可选

业务数据

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

hasMoreboolean可选

是否还有下一页数据。true 表示仍有数据可继续拉取。

注意空库时返回 truelistnullnextKey.msgId0,自相矛盾。不能单凭 hasMore 决定是否继续翻页,否则会死循环。

listobject[]可选

数据列表

注意:空结果时是 null 而非空数组。账号无待发任务,元素结构完全未确认

数组元素 · object

idint64可选

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

seqint64可选

同步序号

增量同步序号。首次请求通常传 0,后续传上次响应返回的序号。

timeStampint64可选

时间戳

totalCntint64可选

总数

nowCntint64可选

已完成数

contentListobject[]可选

消息内容列表。每项 {contentType, content}content 为数组

数组元素 · object

contentTypeint64可选

内容类型。0=文本 14=图片(完整枚举见平台「企微错误码」章节)

contentobject[]可选

内容

消息/动态正文。纯文本类接口传字符串;媒体类传对象(把上传接口返回的 data 整体带上)

数组元素 · object

typeint64可选

类型

内容片段类型:0 文本、3 表情;其他值以平台定义为准。

textstring可选

文本内容。

appInfostring可选

企微内部应用标识,透传字段,无需处理

groupIdint64可选

分组 ID。

statusint64可选

状态

登录状态。-1=未认证需扫码 0=可免扫码 1=已扫码待确认 2=认证成功 4=用户取消 10=待输入6位验证码

extraInfoobject可选

扩展信息

senderNumsint64可选

当前已发送数量。

senderTotalNumsint64可选

计划发送总数量。

serviceMemberint64可选

服务成员 ID。平台数值字段,原样保留。

bAllowSelectint64可选

是否允许选择接收对象;平台使用整数标志位表示。

creatorint64可选

群发任务创建者 ID。

sendModelobject可选

群发任务的发送模式配置。

typeint64可选

类型

群发模式类型枚举值,由平台定义。

groupIdint64可选

分组 ID。

execTimeint64可选

任务执行时间,Unix 时间戳(秒)。

conversationTypeint64可选

会话类型

nextKeyobject可选

下一页游标

下一页游标对象;翻页时按响应原样回传。

注意:形如 {msgId: <数字>}。空库时为 {msgId: 0},其作为下一页入参的正确用法未确认(该接口契约中也没有对应的入参字段)。

msgIdint64可选

消息 ID。用于撤回、状态查询或消息关联。

detailstring可选

错误详情

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

messagestring必填

响应消息

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

字段示例:"ok"
timestring必填

服务端时间

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

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

HTTP 403

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

HTTP 404

appid 不存在或无权访问

搜索接口

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