获取员工的客户列表
最后更新:2024/05/21企业可通过此接口,获取员工添加的客户
注意:接口返回的数据包含了员工主动删除了的客户(若不需要此部分数据,可通过“is_del”字段过滤该数据),而本应用PC管理后台-客户列表中的数据是不包含员工主动删除了的客户的,所以两边数量可能会有差异。
请求方式: POST(HTTPS)
请求地址: https://open.wshoto.com/openapi/user/customer/list?access_token=x
参数说明:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 调用接口凭证 |
Body参数:
{
"user_id":"jiameng",
"add_start_date": 1716200056000,
"add_end_date": 1716286456331,
"current_index":1,
"page_size":2
}
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
user_id | string | 是 | 用户Id |
add_start_date | long | 否 | 添加开始时间,时间戳(毫秒) |
add_end_date | long | 否 | 添加结束时间,时间戳(毫秒) |
current_index | int | 否 | 页码。默认值为1 |
page_size | int | 否 | 列表返回长度。默认值为20,最大值为100 |
返回值:
{
"code": 0,
"msg": "请求成功",
"data": {
"total": 31,
"records": [
{
"external_userid": "wmDkH9EAAAK0_VM8XC6lqFK_GUha5WcQ",
"name": "赵霞",
"position": null,
"avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM7ecYeqXAb9wXzoKcibibeP0mibiajQbfgPVMjxia7D1UFiavRw/0",
"corp_name": null,
"corp_full_name": null,
"external_profile": null,
"type": 1,
"gender": 0,
"user_id": "jiameng",
"remark": "赵霞",
"remark_corp_name": null,
"remark_mobiles": "",
"add_way": "1",
"add_way_str": "扫描二维码",
"open_userid": "wmDkH9EAAAK0_VM8XC6lqFK_GUha5WcQ",
"state": null,
"description": "",
"add_time": 1642128105,
"tag_list": null,
"remark_birthday": null,
"remark_email": null,
"remark_region_code": null,
"remark_region": null,
"remark_add_way": null,
"charge": null,
"is_del": true,
"is_loss": false,
"owner_id_list": null
},
{
"external_userid": "wmDkH9EAAAsMY_TnpiCDvZKFkgE9hXGg",
"name": "平 平 淡 淡 ゜",
"position": null,
"avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM71eoa4kiadT1YIKic23g6OKM2icZMibhQonXjEdKyV4EJewA/0",
"corp_name": null,
"corp_full_name": null,
"external_profile": null,
"type": 1,
"gender": 0,
"user_id": "jiameng",
"remark": "平 平 淡 淡 ゜",
"remark_corp_name": null,
"remark_mobiles": "",
"add_way": "1",
"add_way_str": "扫描二维码",
"open_userid": "wmDkH9EAAAsMY_TnpiCDvZKFkgE9hXGg",
"state": null,
"description": "",
"add_time": 1642128097,
"tag_list": null,
"remark_birthday": null,
"remark_email": null,
"remark_region_code": null,
"remark_region": null,
"remark_add_way": null,
"charge": null,
"is_del": false,
"is_loss": false,
"owner_id_list": null
}
]
}
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
code | int | 出错返回码,为0表示成功,非0表示调用失败 |
msg | string | 返回码描述 |
data | object | 分页对象 |
total | int | 数据条数 |
records | object[] | 客户信息 |
external_userid | string | 客户ID |
name | string | 客户名称 |
position | string | 职位 |
avatar | string | 头像 |
corp_name | string | 客户所在企业的简称 |
corp_full_name | string | 客户所在企业的主体名称 |
external_profile | string | 客户的自定义展示信息 |
type | int | 客户类型,1:微信用户, 2:企业微信用户 |
gender | int | 0未知,1男性,2女性 |
user_id | string | 用户ID(添加人) |
remark | string | 客户备注 |
remark_corp_name | string | 用户给客户备注企业名称 |
remark_mobiles | string | 用户被客户备注的手机号码 |
add_way | string | 客户来源 |
add_way_str | string | 客户来源文本 |
open_userid | string | 如果用户主动添加,为用户的userid;如果是客户主动添加,则为客户的外部联系人userid;如果是内部用户共享/管理员分配,则为对应的成员/管理员userid |
state | string | 区分客户具体通过那个联系我添加 |
description | string | 客户表述 |
add_time | long | 用户添加客户的时间 |
tag_list | array | 用户给客户打标签列表 |
tag_id | string | 标签的id |
tag_name | string | 标签名称 |
type | int | 标签类型, 1-企业设置, 2-用户自定义 |
group_name | string | 标签的分组名称 |
remark_birthday | long | 客户生日 |
remark_email | string | 备注的邮箱 |
remark_region_code | string | 备注的地区码 |
remark_region | string | 备注的地址 |
remark_add_way | string | 备注的获客渠道 |
charge | string | 当客户被第一添加人删除时,则显示为第2个添加员工为负责人,以此类推;如客户所有企业成员都被删了,则展示第一个添加人为负责人 |
is_del | boolean | 员工是否删除客户 |
is_loss | boolean | 客户是否删除员工 |
owner_id_list | array | 负责人ID列表 |