青鸾QINGLUAN
控制台

同步通讯录

同步通讯录。svrVersion 必须传字符串,首次传 "0";传数字 0 会被拒绝。

POST/qingluan/api/contact/getSyncList

接口说明

同步通讯录。svrVersion 必须传字符串,首次传 "0";传数字 0 会被拒绝。

请求参数

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

Content-Type:application/json

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

appidstring必填

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

字段示例:"we_xxxxxxxxxxxxxxx"
svrVersionstring必填

通讯录版本号,字符串。首次全量同步传空串 "";增量同步把上次响应的 data.svrVersion 原样回传。传数字会被拒绝。

字段示例:""

响应与结果确认

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

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

响应字段与 HTTP 状态

HTTP 200

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

application/json

查看响应字段定义

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

codeinteger必填

业务状态码

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

字段示例:0
dataobject可选

业务数据

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

changeboolean可选

是否有变更

needFullUpdateboolean可选

是否需要全量更新

注意:首次调用返回 true。为 true 时应按全量重建本地通讯录,而不是做增量合并。

svrVersionstring可选

服务端版本串,增量同步时回传

nodeListobject[]可选

通讯录节点列表。type=1 为成员(带 vid),type=2 为部门

数组元素 · object

typeint64可选

类型

通讯录节点类型:1 成员,2 部门。

partyIdint64可选

partyId

seqint64可选

同步序号

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

corpScaleint64可选

企业规模标识

注意:返回 1(测试企业规模很小)。具体分档含义未确认。

detailstring可选

错误详情

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

messagestring必填

响应消息

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

字段示例:"ok"
timestring必填

服务端时间

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

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

HTTP 403

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

HTTP 404

appid 不存在或无权访问

搜索接口

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