企业可通过此接口获取指定成员添加的客户列表。客户是指配置了客户联系功能的成员所添加的外部联系人。没有配置客户联系功能的成员,所添加的外部联系人将不会作为客户返回。
权限说明:
调用接口的应用需要满足如下的权限:
应用类型 | 权限要求 |
---|---|
自建应用 | 配置到「客户联系 可调用接口的应用」中 |
代开发应用 | 具有「客户基础信息」权限 |
第三方应用 | 具有「客户基础信息」权限 |
应用只能获取到可见范围内的配置了客户联系功能的成员。
注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情
请求方式:GET(HTTPS)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list?access_token=ACCESS_TOKEN&userid=USERID
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证 |
userid | 是 | 企业成员的userid |
返回结果:
{
"errcode": 0,
"errmsg": "ok",
"external_userid":
[
"woAJ2GCAAAXtWyujaWJHDDGi0mACAAA",
"wmqfasd1e1927831291723123109rAAA"
]
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |
external_userid | 外部联系人的userid列表 |