一、简要总结
本文档是企业微信 iPad 协议接口的联系人模块功能说明,共包含20 个细分操作接口,所有接口统一采用POST请求、ContentType:application/json格式,uuid 为唯一必传核心参数,服务域名以[172.0.0.1:8083](172.0.0.1:8083)为主、少量为[127.0.0.1:8083](127.0.0.1:8083);接口覆盖内部 / 外部联系人管理、好友申请处理、备注 / 会话设置、多渠道添加好友、联系人共享、互联企业 / 企业互联数据拉取全场景,支持seq/strSeq 分页、批量查询、拉黑 / 取消拉黑等核心能力。
- 思维导图
- 官网地址:极客互动企业微信聚合聊天&企业微信API接口
API调用:企业微信API接入文档
四、详细总结
(一)通用核心规范
核心项 | 关键信息 |
请求方式 | POST |
数据格式 | application/json |
必传参数 | uuid(实例唯一标识) |
分页参数 | seq/strSeq(分页下标)、limit(单次返回数量) |
服务域名 | 主域名:[172.0.0.1:8083](172.0.0.1:8083);本地域名:[127.0.0.1:8083](127.0.0.1:8083) |
成功返回 | errcode=0、errmsg=ok |
(二)基础联系人操作(1.8.1-1.8.16)
- 联系人列表获取
- 1.8.1获取内部联系人列表:支持分页拉取企业内部员工 + 部门数据
- 1.8.2获取外部联系人列表:分页拉取外部客户,返回status标识好友状态
- 1.8.6获取好友申请列表:分页查询待处理好友申请,item_flag=3为删除申请
- 1.8.11获取内部联系人备注列表:分页拉取内部同事备注信息
- 1.8.7/1.8.8获取会话 / 标记列表:查询置顶、免打扰、折叠、星星标记会话
- 联系人信息操作
- 1.8.3根据 vid 批量获取详情:支持多用户 id 一次性查询信息
- 1.8.4同意好友:通过回调 vid 处理好友申请
- 1.8.5删除联系人:传入 vid 直接删除联系人
- 1.8.9/1.8.10修改备注:分别支持外部 / 内部联系人备注、手机、企业、简介修改
- 会话与权限设置
- 1.8.12置顶设置:state=0 取消 / 1 设置,区分好友 / 群聊
- 1.8.13免打扰设置:state=0 取消 / 1 设置
- 1.8.14免打扰 + 折叠:state=0 取消 / 1 设置
- 1.8.15星星标记:state=0 取消 / 1 设置
- 1.8.16拉黑 / 移除拉黑:type=1 拉黑 / 2 移除,拉黑后外部联系人status=8
(三)联系人添加方式(1.8.17)
共5 种添加渠道,覆盖全场景加好友:
- [1.8.17.1](1.8.17.1)手机号搜索:输入手机号检索企微 / 个微用户
- [1.8.17.2](1.8.17.2)搜索添加外部联系人:基于搜索结果添加外部客户
- [1.8.17.3](1.8.17.3)搜索添加企微用户:定向添加企业微信内部员工
- [1.8.17.4](1.8.17.4)名片添加:通过推荐人 id + 名片添加好友
- [1.8.17.5](1.8.17.5)直接添加好友:仅适用于被删除过的联系人
(四)联系人共享操作(1.8.18)
- [1.8.18.1](1.8.18.1)共享联系人:将外部客户共享给指定同事账号
- [1.8.18.2](1.8.18.2)添加共享联系人:接收同事共享的客户并发送申请
(五)互联企业 / 企业互联(1.8.19-1.8.20)
- 互联网企业(1.8.19)
- 先调用getCircleIds获取互联企业 ID
- 再通过GetHuLianInnerContacts拉取互联企业部门 + 成员
- 企业互联(1.8.20)
- 先调用getGroupIds获取互联组 ID
- 再通过getGroupChangeData拉取组内企业、部门、成员(node_type=1 用户 / 2 部门 / 3 企业)
(六)关键状态标识
- 外部联系人status:0 互相删除、8 主动拉黑、2049 被删除、其余为正常好友
- 消息类型messagetype:0 好友、1 群聊、3 应用、6 开放平台
- 好友申请item_flag:3 为已删除申请
四、技术特点
特性 | 说明 |
通信协议 | HTTP + JSON |
请求方式 | POST |
Content-Type | application/json |
认证机制 | 使用uuid唯一标识实例,绑定特定企业微信账户 |
分页机制 | 多数接口使用limit+seq(序列号)实现增量加载 |
返回格式 | 统一结构{ errcode: 0, errmsg: "ok", data: ... } |
五、应用场景建议
场景 | 可用接口 |
客户管理系统集成 | 获取外部联系人、修改备注、标签、拉黑 |
自动化营销工具 | 搜索添加客户、发送验证消息、共享客户 |
团队协作平台 | 共享联系人、获取内部联系人、互联企业同步 |
IM 功能增强 | 置顶、免打扰、折叠、星标等会话管理 |
数据分析后台 | 批量拉取用户信息、统计部门结构 |
六、关键问题与答案
问题 1:该模块接口的核心必传参数是什么?作用是什么?
答案:核心必传参数是uuid,它是每个企业微信实例的唯一标识,接口通过 uuid 定位到具体的企业微信账号,完成对应账号的联系人操作。
问题 2:外部联系人的status 状态码分别代表什么好友关系?
答案:
- 0:互相删除好友
- 8:主动删除 / 拉黑对方
- 2049:被对方删除
- 其他数值:正常好友关系
问题 3:接口支持的联系人添加方式有哪几种?各有什么适用场景?
答案:共 5 种添加方式,适用场景如下:
- 手机号搜索添加:已知对方手机号,检索并添加企微 / 个微用户
- 搜索添加外部 / 企微用户:定向添加外部客户或企业内部员工
- 名片添加:通过他人分享的名片添加好友
- 直接添加:仅适用于曾被删除过的联系人,无需重新申请