获取客户列表
GET/open-api/external_user/list获取客户列表。可以通过调整 query 参数满足不同维度的筛选需求。 列表可根据时间进行筛选。调用此接口需购买基础席位。
| 错误码 | 说明 |
|---|---|
| 20201 | staff_id 错误，找不到对应员工 |
| 20202 | type 不合法 |
| 20202 | order 不合法 |
请求参数
Query 参数
staff_id
string
可选
企业微信员工id。若填写则只会返回该员工对应的客户(被员工删除的客户不展示)
示例值:
zhangsan
type_
string
可选
客户类型。1为微信客户，2为企业微信客户。若填写则只返回对应类型的客户
示例值:
1
phone_number
string
可选
客户手机号。若填写则只会返回该手机号对应的客户
示例值:
13322665599
order
string
可选
排序按照微伴系统收录时间升序或降序增加排序参数 order，可选值是 asc(升序) 和 desc(降序)，默认值是 asc
示例值:
asc
start_time
string
可选
时间筛选开始时间,时间戳格式,例如:1592576435对应2020-06-19 22:20:35
示例值:
1592576435
end_time
string
可选
时间筛选结束时间,时间戳格式,例如:1592576435对应2020-06-19 22:20:35
示例值:
1592576435
limit
string
可选
列表返回长度。默认值为30，最大值为100
示例值:
30
offset
string
可选
列表偏移。用于迭代获取所有数据，默认值为0
示例值:
0
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
errcode
integer
必需
状态码，0为正常，非0代表错误。业务错误码下述，全局错误码见 全局错误码
errmsg
string
必需
错误信息，成功时为'ok'，错误时会以中文方式显示错误原因
total
integer
session总量
external_user_list
array [object {15}]
客户列表
id
string
外部联系人客户ID
type
integer
外部联系人的类型，1表示该外部联系人是微信用户，2表示该外部联系人是企业微信用户
unionid
string
仅当联系人类型是微信用户，且企业绑定了微信开发者ID有此字段
created_at
integer
数据创建时间（微伴系统内时间）
name
string
外部联系人昵称
avatar
string
外部联系人头像
corp_full_name
string
外部联系人所在企业的主体名称，仅当联系人类型是企业微信用户时有此字段
corp_name
string
外部联系人所在企业的简称，仅当联系人类型是企业微信用户时有此字段
gender
integer
外部联系人性别 0-未知 1-男性 2-女性
position
string
外部联系人的职位，如果外部企业或用户选择隐藏职位，则不返回，仅当联系人类型是企业微信用户时有此字段
organization_correlation_time
integer
关联企业的时间
organization_id
integer
关联企业ID
score
integer
用户评分
tyc_id
integer
关联企业天眼查ID
external_profile
object
外部联系人的自定义展示信息，可以有多个字段和多种类型，包括文本，网页和小程序，仅当联系人类型是企业微信用户时/有此字段，字段详情见企业微信对应文档
示例
{
"errcode": 0,
"errmsg": "string",
"total": 0,
"external_user_list": [
{
"id": "string",
"type": 0,
"unionid": "string",
"created_at": 0,
"name": "string",
"avatar": "string",
"corp_full_name": "string",
"corp_name": "string",
"gender": 0,
"position": "string",
"organization_correlation_time": 0,
"organization_id": 0,
"score": 0,
"tyc_id": 0,
"external_profile": {}
}
]
}最后修改时间： 9 个月前