青鸾QINGLUAN
控制台

群消息置顶

把一条群消息置顶。请求体是整条消息对象本身(发送接口返回的 data 可直接使用),不要再包一层。

POST/qingluan/api/message/roomMessageTopAdd

接口说明

把一条群消息置顶。请求体是整条消息对象本身(发送接口返回的 data 可直接使用),不要再包一层。

请求参数

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

Content-Type:application/json

appidstring必填

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

字段示例:"we_xxxxxxxxxxxxxxx"
idinteger可选

消息 ID。发送接口返回的 data.id

syncKeyinteger可选

分页游标。首次传 0,之后传上一页返回的 syncKey

messageTypeinteger可选

消息类型枚举。

fromUserIdinteger可选

发送方 ID。

toUserIdinteger可选

接收方 ID。

roomIdinteger可选

群 ID。取自「创建群聊」「查询我的客户群」。注意查询接口返回的是字符串,回传时需转整数。

contentTypeinteger可选

内容类型码。

sendTimeinteger可选

发送时间戳(秒)。

appInfostring可选

消息指纹串,原样回填。

senderNamestring可选

发送者显示名。

content未限定[]可选

正文。结构随 contentType 变化,原样回填。

extraData未限定可选

data 一并回填,不需要自行构造。

flag未限定可选

data 一并回填,不需要自行构造。

devInfo未限定可选

data 一并回填,不需要自行构造。

summary未限定可选

data 一并回填,不需要自行构造。

响应与结果确认

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

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

响应字段与 HTTP 状态

HTTP 200

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

application/json

查看响应字段定义

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

codeinteger必填

业务状态码

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

字段示例:0
dataobject可选

业务数据

接口无固定结构化返回数据;成功时通常为空对象或省略 data

注意:成功时恒为 null,没有任何回执内容。判断成功只能看 code;但本接口可以用回调里的 1001 载荷做二次确认。

detailstring可选

错误详情

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

messagestring必填

响应消息

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

字段示例:"ok"
timestring必填

服务端时间

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

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

HTTP 403

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

HTTP 404

appid 不存在或无权访问

搜索接口

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