1.1. 外部联系人信息
该接口用于获取外部联系人信息
1.1.1. 请求方法
POST api/v1/getExternalUser
1.1.2. 请求参数
| 参数 | 是否必须 | 说明 |
|---|---|---|
| corpId | 是 | 企业微信corpId |
| externalUserId | 是 | 外部联系人的userid，注意不是企业成员的帐号 |
1.1.3. 入参示例
{
"corpId":"wxxxxxxxxxxx078",
"externalUserId":"xxxxxxxxx"
}
1.1.4. 返回数据
| 属性名 | 类型 | 说明 |
|---|---|---|
| errcode | 整型 | 返回码 |
| errmsg | 字符串 | 对返回码的文本描述内容 |
| external_contact | 对象 | 外部联系人对象 |
| - external_userid | 字符串 | 外部联系人的userid |
| - name | 字符串 | 外部联系人的名称 |
| - avatar | 字符串 | 外部联系人头像 |
| - type | 整型 | 外部联系人的类型，1表示该外部联系人是微信用户，2表示该外部联系人是企业微信用户 |
| - gender | 整型 | 外部联系人性别 0-未知 1-男性 2-女性。 |
| - unionid | 字符串 | 外部联系人在微信开放平台的唯一身份标识（微信unionid） |
| - position | 字符串 | 外部联系人的职位，如果外部企业或用户选择隐藏职位，则不返回，仅当联系人类型是企业微信用户时有此字段 |
| - corp_name | 字符串 | 外部联系人所在企业的简称，仅当联系人类型是企业微信用户时有此字段 |
| - corp_full_name | 字符串 | 外部联系人所在企业的主体名称，仅当联系人类型是企业微信用户时有此字段。 |
1.1.5. 返回示例
{
"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"
}