根据更新时间获取客户列表

根据【用户信息变更】、【基本+自定义信息变更】、【客户关系数据变更】、【标签数据变更】信息变更获取客户列表。可以通过调整 query 参数满足不同维度的筛选需求。列表可根据时间进行筛选。调用此接口需购买基础席位。

错误码	说明
20201	order 错误，找不到对应员工
20202	staff_id 不合法
20203	type 不合法
10049	其它参数错误

请求参数

Query 参数

order

string

可选

排序按照微伴系统收录时间升序或降序增加排序参数 order，可选值是 asc(升序) 和 desc(降序)，默认是desc

示例值:

desc

source

string

必需

客户关联信息的类型,可选external_user(用户信息), remark(客户详情页的基本信息和自定义信息), staff_relation(客户关系), tag_relation(标签数据)。
(注：返回的数据是external_user的updated_at，source选external_user外的其他条件是筛选（remark:客户更新基本信息， staff_relation:客户更新关系，tag_relation: 客户更新标签）时间。)

示例值:

staff_relation

staff_id

string

可选

企业微信员工id。若填写则只会返回该员工对应的客户，如果source为staff_relation(客户关系)的时候必填staff_id

示例值:

WuYaJun

start_update_time

string

可选

时间筛选开始时间,时间戳格式,例如:1592576435对应2020-06-19 22:20:35

示例值:

1634054400

end_update_time

string

可选

时间筛选结束时间,时间戳格式,例如:1592576435对应2020-06-19 22:20:35

示例值:

1634140799

start_add_time

integer

可选

添加时间筛选开始时间,时间戳格式,例如:1592576435对应2020-06-19 22:20:35（仅source为staff_relation时生效）

示例值:

1634054400

end_add_time

integer

可选

添加时间筛选结束时间,时间戳格式,例如:1592576435对应2020-06-19 22:20:35（仅source为staff_relation时生效）

示例值:

1634140799

limit

integer

可选

列表返回长度。默认值为30，最大值为100

示例值:

offset

integer

可选

列表偏移。用于迭代获取所有数据，默认值为0

示例值:

phone_number

string

可选

客户手机号。若填写则只会返回该手机号对应的客户

示例值:

13322665588

type

string

可选

客户类型。1为微信客户，2为企业微信客户。若填写则只返回对应类型的客户

示例值:

access_token

string

调用接口凭证

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

errcode

integer

可选

状态码，0为正常，非0代表错误。业务错误码下述，全局错误码见全局错误码

errmsg

string

可选

错误信息，成功时为'ok'，错误时会以中文方式显示错误原因

total

integer

session总量

可选

external_user_list

array[object (ExternalUserListItem) {15}]

客户列表

可选

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": "ok",
  "total": 2,
  "external_user_list": [
    {
      "id": "wm8xjUCAAAS4ozkSaSL7WIyxhV3iROJw",
      "type": 1,
      "unionid": "oz9xvw_jfkmHMGWVSn5CatKSTOMU",
      "created_at": 1579243948,
      "updated_at": 1579243966,
      "name": "clth",
      "avatar": "http://wx.qlogo.cn/mmhead/Q3auHgzwzM6uFkY7eOZOK4bo3lMOKdYBcYrWYZ8cFuxYj6iaULHjLibQ/0",
      "corp_full_name": null,
      "corp_name": null,
      "gender": 1,
      "position": null,
      "external_profile": null,
    }, {
      "id": "wo8xjUCAAAGfqRyM0CGqryOsaKOYgEZE",
      "unionid": null,
      "type": 2,
      "avatar": "http://wework.qpic.cn/wwhead/duc2TvpEgSSWiaVLaJnssadlFTDmCx02UVDuwokogpHxY1Xvic8RLictvU5ON0mH9qHehk3Y8o6oFY/0",
      "name": "张三",
      "gender": 1,
      "position": "企业微信营销专家",
      "corp_full_name": "武汉夜莺科技有限公司",
      "corp_name": "夜莺科技",
      "created_at": 1583209443,
      "updated_at": 1583209466,
    }
  ]
}

🟢200正常返回