appidstring必填青鸾实例 ID,形如 we_xxxxxxxxxxxxxxx。在开发者控制台「实例与回调」扫码上号后获得。
"we_xxxxxxxxxxxxxxx"批量获取通讯录成员资料。
/qingluan/api/contact/fetchUsersProfileBatch批量获取通讯录成员资料。
nodeList[] 需把「同步通讯录」返回的节点整个原样回填(含 vid 与 partyId),type:1 = 成员,2 = 部门。 ⚠️ 只传 vid、或把 partyId 填成 0 时,接口仍返回 code = 0,但每条只含 uin / partyId / attr2 / attr3 且带 isDelete: true,不含姓名。
请求体必填。通过 QL-Key 请求头携带 APIKey。
Content-Type:application/json
请求参数。字段名区分大小写,请按文档原样传递。
appidstring必填青鸾实例 ID,形如 we_xxxxxxxxxxxxxxx。在开发者控制台「实例与回调」扫码上号后获得。
"we_xxxxxxxxxxxxxxx"nodeListobject[]必填节点列表,元素形如 {"vid": 1688800000000001, "type": 1}。成员节点用 vid 字段(不是 id);type:1=成员,2=部门。
数组元素 · object
typeint64必填类型
注意:契约原描述写的是「设备类型,如 iPad」,这是错的。实际是通讯录节点类型:1=成员(配 vid),2=部门(配 partyId)。
1partyIdint64必填partyId
字段示例:1688000000000002seqint64必填同步序号
增量同步序号。首次请求通常传 0,后续传上次响应返回的序号。
7650540819522257000vidint64可选成员 VID
企业微信成员 VID。可从通讯录同步或成员资料接口获取。
字段示例:1000000000000001本接口为能力层原样返回,不统一增加青鸾外层信封。code = 0 仅表示请求被接受,不保证副作用已完成。
请结合业务数据与本页说明判断实际状态,不要仅凭响应码推断操作效果。
能力层原样返回;code = 0 仅表示请求已受理,业务结果须按接口说明确认。
application/json
接口原样返回平台的业务响应。HTTP 状态码与业务状态码需分别判断:HTTP 200 只表示请求已送达,成功以 code = 0 为准。
codeinteger必填业务状态码
业务状态码:0 表示成功,-1 表示失败;失败原因见 message。
0dataobject可选业务数据
业务返回数据;字段结构见下方定义。
patchListobject[]可选增量补丁列表
数组元素 · object
departmentobject可选部门节点详情;nodeType=2 时返回。
partyIdint64可选partyId
nodeTypeint64可选通讯录节点类型:1 成员,2 部门。
isDeleteboolean可选是否已删除
memberobject可选成员节点详情;nodeType=1 时返回。
uinint64可选用户 UIN
用户唯一数字 ID。外部联系人可从同步结果的 userInfo.uin 获取。
partyIdint64可选成员所属部门 ID。
attr2int64可选成员属性标志位 2,按平台定义解析。
attr3int64可选成员属性标志位 3,按平台定义解析。
isTrimUserInfoboolean可选用户信息是否已裁剪
注意:返回 false。含义未确认(字面像是「是否裁剪了用户信息」,但返回值已经很简,未做进一步验证)。
detailstring可选错误详情
错误详情;无补充信息时通常为空字符串。
messagestring必填响应消息
业务结果消息。成功通常为 ok;企微错误通常为 错误码|错误信息。
"ok"timestring必填服务端时间
服务端时间,格式为 YYYY-MM-DD HH:mm:ss。
"2026-07-21 07:33:17"受控接口,需通过控制台配置
appid 不存在或无权访问