appidstring必填青鸾实例 ID,形如 we_xxxxxxxxxxxxxxx。在开发者控制台「实例与回调」扫码上号后获得。
"we_xxxxxxxxxxxxxxx"获取联系人详细资料。⚠️ 入参是 userIdList(数组),不是单个 userId —— 传单数会返回 userIdList is empty。响应也相应是列表,按传入顺序返回。
/qingluan/api/contact/getUserProfileDetail获取联系人详细资料。⚠️ 入参是 userIdList(数组),不是单个 userId —— 传单数会返回 userIdList is empty。响应也相应是列表,按传入顺序返回。
同事取通讯录 vid(1688 前缀),外部联系人取 uin(7881 前缀)。
请求体必填。通过 QL-Key 请求头携带 APIKey。
Content-Type:application/json
请求参数。字段名区分大小写,请按文档原样传递。
至少满足以下一项约束 anyOf
此条件要求提供:userIdList。
此条件要求提供:userId。
appidstring必填青鸾实例 ID,形如 we_xxxxxxxxxxxxxxx。在开发者控制台「实例与回调」扫码上号后获得。
"we_xxxxxxxxxxxxxxx"userIdListint64[]可选用户 ID 列表
用户 ID 列表。必须是数组,传单个数字会返回 userIdList is empty。
数组元素 · int64
[1688000000000001]userIdinteger可选用户 ID。前缀决定类型:1688… 是本企业成员(取自「同步通讯录」的 vid),7881… 是外部联系人(取自「同步外部联系人」的 uin)。其他前缀会被直接拒绝。
本接口为能力层原样返回,不统一增加青鸾外层信封。code = 0 仅表示请求被接受,不保证副作用已完成。
请结合业务数据与本页说明判断实际状态,不要仅凭响应码推断操作效果。
能力层原样返回;code = 0 仅表示请求已受理,业务结果须按接口说明确认。
application/json
接口原样返回平台的业务响应。HTTP 状态码与业务状态码需分别判断:HTTP 200 只表示请求已送达,成功以 code = 0 为准。
codeinteger必填业务状态码
业务状态码:0 表示成功,-1 表示失败;失败原因见 message。
0dataobject可选业务数据
业务返回数据;字段结构见下方定义。
vidint64可选成员 VID
企业微信成员 VID。可从通讯录同步或成员资料接口获取。
infoobject可选用户扩展资料对象。
注意:内部同事与外部联系人返回的字段集不同:内部有 realName/englishName/bizMail/unionId/vCode/mainPartyId/holidayInfo/...;外部只有 uin/name/gender/iconUrl/corpId/attr2/attr3。解析代码必须容忍缺字段,不能按内部档案的形状硬解外部联系人。
uinint64可选用户 UIN
用户唯一数字 ID。外部联系人可从同步结果的 userInfo.uin 获取。
namestring可选名称
名称/昵称
注意:姓名在 data.info.name,不在顶层。契约语义容易读错,接入时注意层级。
emailAddrstring可选邮箱
birthdaystring可选生日
phonestring可选手机号
手机号(11 位)
jobstring可选职位信息。
numberstring可选工号
genderint64可选性别枚举:0 未知,1 男,2 女。
[0, 1, 2]iconUrlstring可选头像 URL
corpIdint64可选企业 ID
企业 ID。
attrint64可选属性位
dispOrderint64可选显示排序
bizUinint64可选企业侧 uin
positionstring可选职位或位置说明。
aliasstring可选别名。传空串可清除
mainPartyIdint64可选主部门 ID
gidint64可选分组 ID
isNameVerifiedboolean可选是否已实名
createSourceint64可选联系人创建来源枚举值,由平台定义。
internationCodestring可选国际区号。
bindEmailStatusint64可选邮箱绑定状态
englishNamestring可选英文名
customInfoobject可选自定义信息
nameVerifyStatusint64可选实名校验状态
realNamestring可选真实姓名。
vCorpUseStatusint64可选虚拟企业使用状态
inviteVidint64可选邀请人 vid
holidayInfoobject可选休假信息
holidayStatusint64可选休假状态
holidayDescstring可选休假说明
oldHolidayIconIndexint64可选旧休假图标序号
createTimeint64可选创建时间戳(秒)
holidayInfoIdint64可选休假信息 ID
holidayIconIndexint64可选休假图标序号
holidayGenerateSrcint64可选休假来源
holidayStatusNewint64可选新版休假状态
vacationSyncTypeint64可选休假同步类型
xcxStyleint64可选小程序样式配置
attr2int64可选属性位 2
tencentInfoobject可选腾讯侧扩展信息
isSyncInnerPositionboolean可选是否同步内部职位
unionIdstring可选微信生态下的 unionid。
vCodestring可选校验码
personalWorkTypeint64可选个人工作类型
bizMailstring可选企业邮箱
attr3int64可选属性位 3
mobileAreaCodeint64可选手机号国家码,如 86
levelint64可选联系人关系级别或状态枚举值,由平台定义。
注意:内部同事 = 3,外部联系人 = 1。分档的确切含义未确认,仅可作为「两类联系人返回不同」的旁证。
detailstring可选错误详情
错误详情;无补充信息时通常为空字符串。
messagestring必填响应消息
业务结果消息。成功通常为 ok;企微错误通常为 错误码|错误信息。
"ok"timestring必填服务端时间
服务端时间,格式为 YYYY-MM-DD HH:mm:ss。
"2026-07-21 07:33:17"受控接口,需通过控制台配置
appid 不存在或无权访问