青鸾QINGLUAN
控制台

查询用户详情

获取联系人详细资料。⚠️ 入参是 userIdList(数组),不是单个 userId —— 传单数会返回 userIdList is empty。响应也相应是列表,按传入顺序返回。

POST/qingluan/api/contact/getUserProfileDetail

接口说明

获取联系人详细资料。⚠️ 入参是 userIdList(数组),不是单个 userId —— 传单数会返回 userIdList is empty。响应也相应是列表,按传入顺序返回。

同事取通讯录 vid(1688 前缀),外部联系人取 uin(7881 前缀)。

请求参数

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

Content-Type:application/json

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

至少满足以下一项约束 anyOf

  1. 此条件要求提供:userIdList

  2. 此条件要求提供:userId

appidstring必填

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

字段示例:"we_xxxxxxxxxxxxxxx"
userIdListint64[]可选

用户 ID 列表

用户 ID 列表。必须是数组,传单个数字会返回 userIdList is empty

数组元素 · int64

字段示例:[1688000000000001]
userIdinteger可选

用户 ID。前缀决定类型1688… 是本企业成员(取自「同步通讯录」vid),7881… 是外部联系人(取自「同步外部联系人」uin)。其他前缀会被直接拒绝。

响应与结果确认

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

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

响应字段与 HTTP 状态

HTTP 200

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

application/json

查看响应字段定义

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

codeinteger必填

业务状态码

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

字段示例:0
dataobject可选

业务数据

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

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"

HTTP 403

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

HTTP 404

appid 不存在或无权访问

搜索接口

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