青鸾QINGLUAN
控制台

群发消息

群发助手。contentList[].content 是数组,如 [{"type":0,"text":"内容"}];receiverList 填接收人 ID。

POST/qingluan/api/message/groupSend

接口说明

群发助手。contentList[].content 是数组,如 [{"type":0,"text":"内容"}];receiverList 填接收人 ID。

:::tip 🔗 调用关系

准备素材与接收人 → 创建群发任务 → 根据任务状态继续处理。 :::

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

请求参数

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

Content-Type:application/json

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

appidstring必填

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

字段示例:"we_xxxxxxxxxxxxxxx"
customerGroupboolean必填

是否发送到客户群,布尔值。只接受 true / false —— 传数字 0 或字符串 "0" 都会被拒绝。

字段示例:false
contentListobject[]必填

消息内容列表。元素为 {contentType, content, appInfo},其中 content 本身是数组,如 [{"type": 0, "text": "内容"}]

数组元素 · object

contentTypeint64必填

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

字段示例:0
contentoneOf必填

内容

群发内容。contentType=0 时传内容片段数组;媒体类型传上传接口返回的数据对象。

必须且只能满足以下一项约束 oneOf

  1. 文本或表情内容片段数组。

    数组元素 · object

    typeint64必填

    类型

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

    字段示例:3
    textstring必填

    文本内容。

    字段示例:"[撇嘴]"
  2. 图片、视频等媒体内容对象;字段取自对应上传接口的返回数据。

    允许额外字段。
receiverListint64[]必填

接收人 ID 列表。元素必须是 uint64 数字,传字符串会被拒绝。

数组元素 · int64

字段示例:10000000000000002
materialIdint64必填

群发素材 ID,可从群发素材列表或待发送任务中获取。

注意:固定传 0。是否允许为 0、以及与 contentList 的互斥/共存关系,均未确认

字段示例:117159486110430460

响应与结果确认

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

发送后通过拉取消息复核。超时或网络中断时,先确认结果,再决定是否重试,避免重复消息。

响应字段与 HTTP 状态

HTTP 200

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

application/json

查看响应字段定义

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

codeinteger必填

业务状态码

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

字段示例:0
dataobject可选

业务数据

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

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 项。