获取客户详情

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

请求方式:GET(HTTPS
请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid=EXTERNAL_USERID

参数说明:

参数 必须 说明
access_token 调用接口凭证
external_userid 外部联系人的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
               }
           ],
           "remark_corp_name":"腾讯科技",
           "remark_mobiles":
            [
              "13800000001",
              "13000000002"
            ],
           "oper_userid":"rocky",
           "add_way":1
        },
        {
          "userid":"tommy",
          "remark":"李总",
          "description":"采购问题咨询",
          "createtime":1525881637,
          "state":"外联二维码1",
          "oper_userid":"woAJ2GCAAAXtWyujaWJHDDGi0mACHAAA",
           "add_way":3
         }
     ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
external_userid 外部联系人的userid
name 外部联系人的名称[注1]
avatar 外部联系人头像,第三方不可获取
type 外部联系人的类型,1表示该外部联系人是微信用户,2表示该外部联系人是企业微信用户
gender 外部联系人性别 0-未知 1-男性 2-女性
unionid 外部联系人在微信开放平台的唯一身份标识(微信unionid),通过此字段企业可将外部联系人与公众号/小程序用户关联起来。仅当联系人类型是微信用户,且企业或第三方服务商绑定了微信开发者ID有此字段查看绑定方法
position 外部联系人的职位,如果外部企业或用户选择隐藏职位,则不返回,仅当联系人类型是企业微信用户时有此字段
corp_name 外部联系人所在企业的简称,仅当联系人类型是企业微信用户时有此字段
corp_full_name 外部联系人所在企业的主体名称,仅当联系人类型是企业微信用户时有此字段
external_profile 外部联系人的自定义展示信息,可以有多个字段和多种类型,包括文本,网页和小程序,仅当联系人类型是企业微信用户时有此字段,字段详情见对外属性
follow_user.userid 添加了此外部联系人的企业成员userid
follow_user.remark 该成员对此外部联系人的备注
follow_user.description 该成员对此外部联系人的描述
follow_user.createtime 该成员添加此外部联系人的时间
follow_user.tags.group_name 该成员添加此外部联系人所打标签的分组名称(标签功能需要企业微信升级到2.7.5及以上版本)
follow_user.tags.tag_name 该成员添加此外部联系人所打标签名称
follow_user.tags.type 该成员添加此外部联系人所打标签类型, 1-企业设置, 2-用户自定义
follow_user.tags.tag_id 该成员添加此外部联系人所打企业标签的id,仅企业设置(type为1)的标签返回
follow_user.remark_corp_name 该成员对此客户备注的企业名称
follow_user.remark_mobiles 该成员对此客户备注的手机号码,第三方不可获取
follow_user.add_way 该成员添加此客户的来源,具体含义详见来源定义
follow_user.oper_userid 发起添加的userid,如果成员主动添加,为成员的userid;如果是客户主动添加,则为客户的外部联系人userid;如果是内部成员共享/管理员分配,则为对应的成员/管理员userid
follow_user.state 企业自定义的state参数,用于区分客户具体是通过哪个「联系我」添加,由企业通过创建「联系我」方式指定

注1:如果外部联系人为微信用户,则返回外部联系人的名称为其微信昵称;如果外部联系人为企业微信用户,则会按照以下优先级顺序返回:此外部联系人或管理员设置的昵称、认证的实名和账号名称。

关于返回的unionid,如果是第三方应用调用该接口,则返回的unionid是该第三方服务商所关联的微信开放者帐号下的unionid。也就是说,同一个企业客户,企业自己调用,与第三方服务商调用,所返回的unionid不同;不同的服务商调用,所返回的unionid也不同。

如何绑定微信开发者ID

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

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

  3. 第三方服务商若需要unionid,则只需要在服务商自身企业管理后台的客户联系-客户-api中联微信开发者ID;第三方调用接口返回的unionid是该服务商所关联的微信开发者帐号的unionid。也就是说,同一个企业客户,企业自己调用,与第三方服务商调用,所返回的unionid不同;不同的服务商调用,所返回的unionid也不同

来源定义

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

含义
0 未知来源
1 扫描二维码
2 搜索手机号
3 名片分享
4 群聊
5 手机通讯录
6 微信联系人
7 来自微信的添加好友申请
8 安装第三方应用时自动添加的客服人员
9 搜索邮箱
201 内部成员共享
202 管理员/负责人分配
© 1998 - 2020 Tencent Inc. All Rights Reserved