青鸾QINGLUAN
控制台
CONTACTS / API REFERENCE

联系人 API

15个接口

同步通讯录,查询、添加和管理业务联系人。 本页列出此分组全部 15 个 POST 接口。

全部接口

同步通讯录

同步通讯录。svrVersion 必须传字符串,首次传 "0";传数字 0 会被拒绝。

POST/qingluan/api/contact/getSyncList

批量查询用户详情

批量获取通讯录成员资料。

POST/qingluan/api/contact/fetchUsersProfileBatch

查询用户详情

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

POST/qingluan/api/contact/getUserProfileDetail

按手机号搜索

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

POST/qingluan/api/contact/phoneNumberSearch

按手机号添加微信用户

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

POST/qingluan/api/contact/phoneNumberAddWechat

按手机号添加企业微信用户

按手机号添加企业微信用户。入参取自「按手机号搜索」的返回。⚠️ 字段名是全小写 userid;不能添加自己。

POST/qingluan/api/contact/phoneNumberAddWework

同意好友申请

同意新客户的好友申请。⚠️ 入参字段是 userId(旧契约写的 uin 已不再受理,会返回 user profile result is empty)。

POST/qingluan/api/contact/agreeToNewCustomer

更新外部联系人资料

修改外部联系人的备注信息。⚠️ 入参字段是 userId(旧契约写的 vid 已不再受理)。

POST/qingluan/api/contact/updateExternalContactInfo

删除联系人

删除联系人。不可逆。

POST/qingluan/api/contact/delete

设置同事备注

设置内部同事的备注与描述。

POST/qingluan/api/contact/setColleagueRemark

通过名片添加

通过名片添加联系人。入参字段为 userId(旧契约中的 cardSourceUserId 已废弃)。

POST/qingluan/api/contact/addCard

从群里添加联系人

把群内成员添加为联系人。userId 传该成员在群里的 ID,可从「获取群资料」的 members[].vid 取。

POST/qingluan/api/contact/addRoomMember

同步外部联系人

同步外部联系人。⚠️ businessId 要传 1 —— 传 0 会返回空列表且不报错,容易被误当成「没有外部联系人」。

POST/qingluan/api/contact/syncExternal

获取企业简要信息

批量获取企业简要信息。corpIds 传企业 ID 数组,不能为空数组(会返回 -2003)。企业 ID 可从联系人资料的 corpId 取。

POST/qingluan/api/contact/getCorpBriefInfoList

更新联系人标签

更新某位联系人身上的标签。operItems 为空数组时表示清空。

POST/qingluan/api/contact/updateLabel

接入常见问题

调用前需要哪些信息?

准备有效 APIKey 和控制台中的 appid,并按具体接口核对必填字段与附加约束。查看接入流程

如何理解返回结果?

本组数据面接口返回能力层原始响应。code = 0 表示请求被接受,实际效果及状态应结合接口说明与查询结果确认。

搜索接口

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