拉取消息

分页拉取消息。首次传 syncKey: 0，之后传上一页返回的 syncKey，直到 isEnd 为 true。

POST/qingluan/api/message/sync

在线调试鉴权与基础约定

接口说明

分页拉取消息。首次传 syncKey: 0，之后传上一页返回的 syncKey，直到 isEnd 为 true。

请求参数

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

Content-Type：application/json

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

appidstring必填

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

字段示例："we_xxxxxxxxxxxxxxx"

limitint64必填

分页大小

单页条数。

最小值：1 字段示例：100

syncKeyint64必填

同步游标

同步游标，整数。首次传 0；不把返回的 syncKey 存下来回传，就会一直拉到同一页。

字段示例：15875106

响应与结果确认

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

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

响应字段与 HTTP 状态

HTTP 200

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

application/json

查看响应字段定义

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

codeinteger必填

业务状态码

业务状态码：0 表示成功，-1 表示失败；失败原因见 message。

字段示例：0

dataobject可选

业务数据

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

countint64可选

本次返回条数

注意：是本页实际返回条数，不是总数。

isEndboolean可选

是否执行完成

liststring | null可选

数据列表

syncKeyint64可选

同步游标

同步键。下次增量同步传回

detailstring可选

错误详情

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

messagestring必填

响应消息

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

字段示例："ok"

timestring必填

服务端时间

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

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

HTTP 403

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

HTTP 404

appid 不存在或无权访问

请求示例

请求示例 · JSON

{
  "appid": "we_xxxxxxxxxxxxxxx",
  "limit": 100,
  "syncKey": 15875106
}

响应示例

HTTP 200 响应示例 · JSON

{
  "code": 0,
  "data": {
    "count": 0,
    "isEnd": false,
    "list": "",
    "syncKey": 0
  },
  "detail": "",
  "message": "ok",
  "time": "2026-07-21 07:33:17"
}

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

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