青鸾QINGLUAN
控制台

按手机号搜索

按手机号搜索。查不到时返回 code: -1(不是空列表)。

POST/qingluan/api/contact/phoneNumberSearch

接口说明

按手机号搜索。查不到时返回 code: -1不是空列表)。

命中后,返回里的 wxTicket / openid / contactInfo.uin / contactInfo.corpId 就是「按手机号添加」两个接口要的入参。

请求参数

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

Content-Type:application/json

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

appidstring必填

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

字段示例:"we_xxxxxxxxxxxxxxx"
phonestring必填

手机号

手机号(11 位)

注意:11 位手机号字符串。号码不存在时返回 code=-1 / 用户不存在,而非空结果集——判空要按错误码判,不要按 data 是否为空数组判(data 直接是 null)。

字段示例:"138****0001"

响应与结果确认

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

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

响应字段与 HTTP 状态

HTTP 200

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

application/json

查看响应字段定义

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

codeinteger必填

业务状态码

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

字段示例:0
dataobject[]可选

业务数据

接口返回数据对象。不同接口的 data 结构不同。

数组元素 · object

contactInfoWxobject可选

匹配到的微信联系人基础资料。

uinint64可选

用户 UIN

用户唯一数字 ID。外部联系人可从同步结果的 userInfo.uin 获取。

namestring可选

名称

名称/昵称

genderint64可选

性别枚举:0 未知,1 男,2 女。

允许值:[0, 1, 2]
iconUrlstring可选

头像 URL

openidstring可选

微信 OpenId

注意搜索成功时返回,是 /api/contact/phoneNumberAddWechatopenid 入参来源(该链路已确认)。此次落盘的是失败样本,成功返回体的其余字段未确认。

resultTypeint64可选

搜索结果类型枚举;结合 corpId 等字段区分个人微信与企业微信。

detailstring可选

错误详情

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

messagestring必填

响应消息

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

字段示例:"ok"
timestring必填

服务端时间

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

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

HTTP 403

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

HTTP 404

appid 不存在或无权访问

搜索接口

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