获取外部联系人详情

GET

http://127.0.0.1/cgi-bin/externalcontact/get

第三方应用开发/家校沟通/基础接口

最后修改时间：2022-08-30 03:03:36

责任人：未设置

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

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

文档ID: 16685
原文档地址：
https://open.work.weixin.qq.com/api/doc/90001/90143/91670
https://open.work.weixin.qq.com/api/doc/90000/90135/92322

请求参数

Query 参数

external_userid

string

必需

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

示例值:

access_token

string

调用接口凭证

必需

示例值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request GET 'http://127.0.0.1/cgi-bin/externalcontact/get?external_userid={{external_userid}}&access_token={{access_token}}'

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

follow_user

array [object {7}]

可选

createtime

integer <int32>

可选

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

description

string

可选

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

remark

string

可选

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

state

string

可选

成员添加此外部联系人的渠道，由用户通过创建「联系我」方式指定

userid

string

可选

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

remark_mobiles

string

必需

该成员对此外部联系人备注的手机号码，第三方不可获取

tags

array [object {3}]

可选

errmsg

string

可选

对返回码的文本描述内容

external_contact

object

可选

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

corp_full_name

string

可选

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

unionid

string

可选

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

gender

integer <int32>

可选

外部联系人性别 0-未知 1-男性 2-女性

foreign_key

string

可选

由企业或服务商在导入家长时指定的关键字，如果家长不是由企业或服务商提前导入再关注的，foreign_key为空

avatar

string

可选

外部联系人头像，第三方不可获取

corp_name

string

可选

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

type

integer <int32>

可选

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

external_userid

string

可选

外部联系人的userid

subscriber_info

object

可选

name

string

可选

外部联系人的姓名或别名

position

string

可选

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

is_subscribe

integer <int32>

可选

外部联系人是否关注了“学校通知”，仅在已经关注时返回，1-已关注

external_profile

object

可选

示例

{
  "errcode": 0,
  "follow_user": [
    {
      "createtime": 0,
      "description": "string",
      "remark": "string",
      "state": "string",
      "userid": "string",
      "remark_mobiles": "string",
      "tags": [
        {
          "group_name": "string",
          "tag_name": "string",
          "type": "string"
        }
      ]
    }
  ],
  "errmsg": "string",
  "external_contact": {
    "corp_full_name": "string",
    "unionid": "string",
    "gender": 0,
    "foreign_key": "string",
    "avatar": "string",
    "corp_name": "string",
    "type": 0,
    "external_userid": "string",
    "subscriber_info": {
      "remark_mobiles": [
        "string"
      ],
      "tag_id": [
        "string"
      ],
      "remark": "string"
    },
    "name": "string",
    "position": "string",
    "is_subscribe": 0,
    "external_profile": {
      "external_attr": [
        {
          "name": "string",
          "type": 0,
          "miniprogram": {
            "pagepath": "string",
            "appid": "string",
            "title": "string"
          }
        }
      ]
    }
  }
}

上传附件资源

发送「学校通知」