如何通过企微 API 获取外部联系人详细信息

企微支持1
5 阅读2分钟

沉淀客户私域数据，实现企业 CRM 系统与企微信息的深度同步

能力介绍

获取外部联系人详情接口是企业微信私域运营的核心能力。通过该接口，企业可以调取客户的昵称、头像、性别、来源渠道、添加时间，以及更具业务价值的标签（Tags） 、备注名、手机号（需权限）和自定义字段。其核心价值在于打破数据孤岛，为客户画像的精准补全提供底层数据支持。

10 分钟接入 Demo

  1. 获取基础权限：确保已在企微后台配置“客户联系”权限，并获取对应的 secret。
  2. 获取 AccessToken：使用 corpid 和 secret 调用 token 接口。
  3. 确定客户 ID：通过“外部联系人列表”接口或回调事件获取目标客户的 external_userid。
  4. 调用详情接口：使用 GET 方式请求 https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get。
  5. 字段映射：将返回的 JSON 数据映射至企业内部的 CRM 数据库。

API 示例代码

以下为基于 Python 的调用示例：

import requests

def get_external_contact_detail(access_token, external_userid):
    # 接口请求地址
    url = f"https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get"
    params = {
        "access_token": access_token,
        "external_userid": external_userid
    }
    
    response = requests.get(url, params=params)
    if response.status_code == 200:
        result = response.json()
        if result.get("errcode") == 0:
            return result.get("external_contact")
    return None

# 调用示例
# detail = get_external_contact_detail("YOUR_TOKEN", "wmNo_SCAAAxxx...")

使用场景说明

  • 客户画像补全：在员工端侧边栏实时展示客户的标签和来源，辅助销售制定话术。
  • SCRM 系统同步：当新客户添加员工时，系统自动拉取详细信息并建立内部唯一档案。
  • 流失预警分析：结合客户的添加时间与标签变更，分析高价值客户的行为轨迹。
  • 精准营销投放：根据 API 获取到的标签信息，在后台筛选特定人群进行消息下发。

FAQ

  • Q：为什么获取不到客户的手机号？

    • A：出于隐私保护，手机号属于敏感字段。需满足特定条件（如获客助手插件或客户主动授权）且在管理后台开启相应权限后方可获取。

  • Q：external_userid 是固定不变的吗？

    • A：对于同一家企业，同一个外部联系人的 external_userid 是唯一的。但如果是不同企业添加同一个客户，获取到的 ID 是不同的。

  • Q：接口调用频率有限制吗？

    • A：有。通常为每分钟及每小时的频率限制，建议在大规模同步数据时采用异步队列处理。

引导入口

查看 API 文档

访问企微官网

avatar
文章
阅读
粉丝