登录
基础
连接微信
办公学校可通过此接口，根据外部联系人的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，注意不是学校成员的账号 |
权限说明：
调用的应用需要满足如下的权限
| 应用类型 | 权限要求 |
|---|---|
| 自建应用 | 配置到「 家校沟通-读取和编辑家校通讯录的应用」或「 家校沟通-读取家校通讯录的应用」或“家长可使用应用”列表中 |
| 代开发应用 | 具有 「家校沟通」权限 |
| 第三方应用 | 具有 「家校沟通」使用权限 |
返回的跟进人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 | 该成员添加此外部联系人的渠道，由用户通过创建「联系我」方式指定 |
2、绑定完成，即可通过接口获取微信联系人所对应的微信union id
基础连接微信办公基础连接微信办公基础连接微信办公