企业内部开发 服务端API 家校沟通 基础接口 获取外部联系人详情
获取外部联系人详情

学校可通过此接口,根据外部联系人的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,注意不是学校成员的帐号

权限说明:
学校需要使用“家校沟通”secret所获取的accesstoken来调用(accesstoken如何获取?);
第三方应用需拥有「家校沟通」使用权限。
第三方应用调用时,返回的跟进人follow_user仅包含应用可见范围之内的成员。

返回结果:

{
   "errcode": 0,
   "errmsg": "ok",
   "external_contact":
   {
       "external_userid":"woAAAA",
      "name":"李四",
	   "position":"Mangaer",
       "avatar":"http://p.qlogo.cn/bizmail/IcsdgagqefergqerhewSdage/0",
	   "corp_name":"腾讯",
       "corp_full_name":"腾讯科技有限公司",
	   "type":2,
	   "gender":1,
	   "unionid":"unAAAAA",
	   "is_subscribe":1,
	   "subscriber_info":
	   {
			"tag_id":[
				"TAG_ID1","TAG_ID2"
			],
			"remark_mobiles":[
        		"10000000000",
        		"10000000001"
   			],
			"remark":"李小明-爸爸"
	   },
    "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": "wxAAAAA",
                      "pagepath": "/index",
                      "title": "my miniprogram"
          }
        }
      ]
    }
   },
    "follow_user":
	[
		{
		"userid":"rocky",
		"remark":"李部长",
		"description":"对接采购事物",
		"createtime":1525779812,
		"tags":[
			{
				"group_name""标签分组名称",
				"tag_name":"标签名称",
				"type":1
			},
		"remark_corp_name":"腾讯科技",
		"remark_mobiles":[
			10000000003,
			10000000004
			]
		]
		},
		{
		"userid":"tommy",
		"remark":"李总",
		"description":"采购问题咨询",
		"createtime":1525881637,
		"state":"外联二维码1"
		}
	]
}

参数说明:

参数说明
errcode返回码
errmsg对返回码的文本描述内容
external_userid外部联系人的userid
name外部联系人的姓名或别名
avatar外部联系人头像,第三方不可获取
type外部联系人的类型,1表示该外部联系人是微信用户,2表示该外部联系人是企业微信用户
gender外部联系人性别 0-未知 1-男性 2-女性
unionid外部联系人在微信开放平台的唯一身份标识(微信unionid),通过此字段企业可将外部联系人与公众号/小程序用户关联起来。仅当联系人类型是微信用户,且企业绑定了微信开发者ID有此字段查看绑定方法
position外部联系人的职位,如果外部企业或用户选择隐藏职位,则不返回,仅当联系人类型是企业微信用户时有此字段
is_subscribe外部联系人是否关注了“学校通知”,仅在已经关注时返回,1-已关注
subscriber_info.tag_id学校为家长设置的标签id
subscriber_info.remark_mobiles学校为家长备注的手机号,第三方不返回
subscriber_info.remark学校对家长的备注信息,默认格式为“学生姓名”-“关系”
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.remark_corp_name该成员对此外部联系人备注的企业名称
follow_user.remark_mobiles该成员对此外部联系人备注的手机号码,第三方不可获取
follow_user.state该成员添加此外部联系人的渠道,由用户通过创建「联系我」方式指定

如何绑定微信开发者ID

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

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

上一篇
发送「学校通知」
下一篇
外部联系人openid转换