青鸾QINGLUAN
控制台

按手机号添加微信用户

通过手机号添加微信联系人。先调「手机号搜索」取得 ticket 与 openid,两个接口成对使用。

POST/qingluan/api/contact/phoneNumberAddWechat

接口说明

通过手机号添加微信联系人。先调「手机号搜索」取得 ticketopenid,两个接口成对使用。

⚠️ 返回码没有判别力:即使不传任何标识字段也返回 code = 0。是否真的发出好友申请,需由对方是否收到来确认。

请求参数

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

Content-Type:application/json

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

appidstring必填

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

字段示例:"we_xxxxxxxxxxxxxxx"
ticketstring必填

凭证。由搜索/名片接口返回

注意:与 openid 同批由搜索接口返回。属凭证类字段,日志与落库须脱敏。

字段示例:""
openidstring必填

微信 OpenId

注意来自 /api/contact/phoneNumberSearch 的返回。这两个接口是成对使用的:先用手机号搜到人,再用搜到的 openid 发起添加。

字段示例:""
verifyMessagestring必填

好友申请附言。

字段示例:"我是某某,添加你方便沟通一下"
remarkPhoneobject[]必填

备注手机号列表,对象数组,元素形如 {"phone": "13800000000"}。不填时传空数组 []不要传空字符串

数组元素 · object

phonestring必填

手机号

手机号(11 位)

字段示例:""
字段示例:[]

响应与结果确认

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

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

响应字段与 HTTP 状态

HTTP 200

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

application/json

查看响应字段定义

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

codeinteger必填

业务状态码

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

字段示例:0
dataobject可选

业务数据

接口无固定结构化返回数据;成功时通常为空对象或省略 data

注意未采集返回体,字段清单未知。

detailstring可选

错误详情

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

messagestring必填

响应消息

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

字段示例:"ok"
timestring必填

服务端时间

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

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

HTTP 403

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

HTTP 404

appid 不存在或无权访问

搜索接口

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