获取客户详情

GET

/cgi-bin/externalcontact/get

服务端API企业内部开发第三方应用开发

企业可通过此接口，根据外部联系人的userid（如何获取?），拉取客户详情。

权限说明：

企业需要使用系统应用“客户联系”或配置到“可调用应用”列表中的自建应用的secret所获取的accesstoken来调用（accesstoken如何获取？）；

第三方应用需具有“企业客户权限->客户基础信息”权限

第三方/自建应用调用时，返回的跟进人follow_user仅包含应用可见范围之内的成员。

当客户在企业内的跟进人超过500人时需要使用cursor参数进行分页获取

注1：如果是微信用户，则返回其微信昵称。如果是企业微信联系人，则返回其设置对外展示的别名或实名

如何绑定微信开发者ID

登录企业的管理后台-客户联系-客户-api（注：若企业管理端没有客户联系的入口，而是家校沟通的入口，则通过家校沟通-家校沟通-api ），点击绑定去到微信公众平台进行授权，支持绑定公众号和小程序（需要同时绑定微信开放平台）；绑定的公众号或小程序主体需与企业微信主体一致，暂且支持绑定一个

绑定完成，即可通过接口获取微信联系人所对应的微信unionid

来源定义

add_way表示添加客户的来源，有固定的值，而state表示此客户的渠道，可以由企业进行自定义的配置，请注意二者的不同。

值	含义
0	未知来源
1	扫描二维码
2	搜索手机号
3	名片分享
4	群聊
5	手机通讯录
6	微信联系人
8	安装第三方应用时自动添加的客服人员
9	搜索邮箱
10	视频号添加
11	通过日程参与人添加
12	通过会议参与人添加
13	添加微信好友对应的企业微信
14	通过智慧硬件专属客服添加
15	通过上门服务客服添加
201	内部成员共享
202	管理员/负责人分配

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token={accesstoken}}&external_userid={{EXTERNAL_USERID}}'

响应示例

{
  "errcode": 0,
  "errmsg": "ok",
  "external_contact": {
    "external_userid": "woAJ2GCAAAXtWyujaWJHDDGi0mACHAAA",
    "name": "李四",
    "position": "Manager",
    "avatar": "http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0",
    "corp_name": "腾讯",
    "corp_full_name": "腾讯科技有限公司",
    "type": 2,
    "gender": 1,
    "unionid": "ozynqsulJFCZ2z1aYeS8h-nuasdAAA",
    "external_profile": {
      "external_attr": [
        {
          "type": 0,
          "name": "文本名称",
          "text": {
            "value": "文本"
          }
        },
        {
          "type": 1,
          "name": "网页名称",
          "web": {
            "url": "http://www.test.com",
            "title": "标题"
          }
        },
        {
          "type": 2,
          "name": "测试app",
          "miniprogram": {
            "appid": "wx8bd80126147df384",
            "pagepath": "/index",
            "title": "my miniprogram"
          }
        }
      ]
    }
  },
  "follow_user": [
    {
      "userid": "rocky",
      "remark": "李部长",
      "description": "对接采购事务",
      "createtime": 1525779812,
      "tags": [
        {
          "group_name": "标签分组名称",
          "tag_name": "标签名称",
          "tag_id": "etAJ2GCAAAXtWyujaWJHDDGi0mACHAAA",
          "type": 1
        },
        {
          "group_name": "标签分组名称",
          "tag_name": "标签名称",
          "type": 2
        },
        {
          "group_name": "标签分组名称",
          "tag_name": "标签名称",
          "tag_id": "stAJ2GCAAAXtWyujaWJHDDGi0mACHAAA",
          "type": 3
        }
      ],
      "remark_corp_name": "腾讯科技",
      "remark_mobiles": [
        "13800000001",
        "13000000002"
      ],
      "oper_userid": "rocky",
      "add_way": 10,
      "wechat_channels": {
        "nickname": "视频号名称",
        "source": 1
      }
    },
    {
      "userid": "tommy",
      "remark": "李总",
      "description": "采购问题咨询",
      "createtime": 1525881637,
      "state": "外联二维码1",
      "oper_userid": "woAJ2GCAAAXtWyujaWJHDDGi0mACHAAA",
      "add_way": 3
    }
  ],
  "next_cursor": "NEXT_CURSOR"
}

请求参数

Query 参数

access_token

调用接口凭证

必需

示例值:

{accesstoken}}

external_userid

必需

外部联系人的userid，注意不是企业成员的帐号

示例值:

cursor

可选

上次请求返回的next_cursor

示例值:

返回响应

🟢200成功

application/json

Body

errcode

integer

返回码返回码

必需

errmsg

string

必需

对返回码的文本描述内容

external_contact

object

必需

external_userid

string

必需

外部联系人的userid

name

string

必需

外部联系人的userid

position

string

必需

外部联系人的职位，如果外部企业或用户选择隐藏职位，则不返回，仅当联系人类型是企业微信用户时有此字段

avatar

string

必需

外部联系人头像，代开发自建应用需要管理员授权才可以获取，第三方不可获取

corp_name

string

必需

外部联系人所在企业的简称，仅当联系人类型是企业微信用户时有此字段

corp_full_name

string

必需

外部联系人所在企业的主体名称，仅当联系人类型是企业微信用户时有此字段

type

integer

必需

外部联系人的类型，1表示该外部联系人是微信用户，2表示该外部联系人是企业微信用户外部联系人的类型，1表示该外部联系人是微信用户，2表示该外部联系人是企业微信用户

gender

integer

必需

外部联系人性别 0-未知 1-男性 2-女性外部联系人的类型，1表示该外部联系人是微信用户，2表示该外部联系人是企业微信用户

unionid

string

必需

外部联系人在微信开放平台的唯一身份标识（微信unionid），通过此字段企业可将外部联系人与公众号/小程序用户关联起来。仅当联系人类型是微信用户，且企业或第三方服务商绑定了微信开发者ID有此字段。查看绑定方法

external_profile

object

必需

外部联系人的自定义展示信息，可以有多个字段和多种类型，包括文本，网页和小程序，仅当联系人类型是企业微信用户时有此字段，字段详情见对外属性；

follow_user

array [object {10}]

必需

userid

string

必需

添加了此外部联系人的企业成员userid

remark

string

必需

该成员对此外部联系人的备注

description

string

必需

该成员对此外部联系人的描述

createtime

integer

必需

该成员添加此外部联系人的时间

获取客户详情

如何绑定微信开发者ID#

来源定义#

请求参数

返回响应

如何绑定微信开发者ID

来源定义