获取客群列表数据-V2（企微外部联系人，外部数据源、留资客户、访客、潜在客户）

POST

/leads/open-api/data-list-v2

最后修改时间：2024-09-23 05:15:12

接口描述

可通过该接口，获取客群列表数据，并支持条件筛选
其中访客不支持条件筛选，并且访客没有创建时间

接口调用限制为

每秒50次。

请求参数说明

通用参数 access_token （使用鉴权模块-获取token接口获取）

参数名称	参数类型	必须	说明
user_id	string	是	系统用户的user_id，以该系统用户的数据权限返回数据。获取方法：1.通过管理员列表接口获取 2.登录系统获取，位置：个人设置-用户ID
condition	array	否	数据查询条件，为空则返回所有数据。支持多字段组合筛选，组合关系为 “且”(即返回数据同时满足多字段条件)。
client_type	int	是	browseCustomers=浏览访客，externalDataSource=外部数据，clientsCustomers=留资客户，mochatLink=企微外部联系人
nextId	int	否	当client_type=externalDataSource，或者=mochatLink时，此值必传，值为表结构ID。通过获取客群对象列表，参数customersField获取
page_num	int	是	页码
page_size	int	是	每页条数
condition_type	string	否	多个条件的组合关系，默认为and。and：条件组合为and关系 or：条件组合为or关系
search_str	string	否	模糊查询参数

注：当client_type=browseCustomers时，支持按 first_visit_time（第一次访问时间）/last_visit_time（最后一次访问时间）字段组合查询，字段类型为DateTime

返回参数说明

参数名称	说明
code	返回码
msg	错误信息
data	数据集

请求参数

Query 参数

access_token

string

必需

示例值:

Body 参数application/json

user_id

string

必需

系统用户的user_id，以该系统用户的数据权限返回数据。获取方法：1.通过管理员列表接口获取 2.登录系统获取，位置：个人设置-用户ID

client_type

string

必需

browseCustomers=浏览访客，externalDataSource=外部数据，clientsCustomers=留资客户，mochatLink=企微外部联系人

nextId

string

必需

当client_type=externalDataSource此值必传，值为外部数据源表结构ID

page_num

string

页码

必需

page_size

string

每页条数

必需

condition

array [object {3}]

可选

数据查询条件，为空则返回所有数据。支持多字段组合筛选，组合关系为 “且”(即返回数据同时满足多字段条件)

field_name

string

可选

字段名称，获取方法：调用“表结构-表结构详情接口”

search_type

string

可选

参数	参数含义
eq	=（等于）
neq	!=（不等于）
like	like（包含）
not_like	not_like （不包含）
not_exist	not_exist（为空）
exist	exist （不为空）
in	in （包含任意）
not_in	not_in （不包含任意）
lt	<（小于）
gt	> （大于）
lte	<=（小于等于）
gte	>=（大于等于）

value

string

可选

字段类型	说明	示例	支持的筛选操作	备注
Text	文本	"hello world"	eq、neq、like、not_like、not_exist、exist	当筛选类型为not_exist、exist时，value不需要传值，其它字段类型同理
TextArea	多行文本	"hello world"	eq、neq、like、not_like、not_exist、exist	---
Email	邮件	"helloworld@qq.com"	eq、neq、like、not_like、not_exist、exist	---
PhoneNumber	手机号	"188xxxxxxxx"	eq、neq、like、not_like、not_exist、exist	---
Select	下拉	"1"	eq、neq、in、not_in、not_exist、exist	调用表结构详情接口，字段options 即为下拉字段的选项，接口传值时使用value。options示例如下: [{"label": "小于100","value": "1"},{"label": "100-200","value": "2"},{"label": "200以上","value": "3"}]
Radio	单选	"1"	eq、neq、in、not_in、not_exist、exist	同下拉
CheckBox	多选	["1","2"]	eq、neq、in、not_in、not_exist、exist	同下拉
DateTime	日期时间	"2023-01-01 00:00:00"	eq、lt、gt、not_exist、exist	---
Date	日期	"2023-01-01"	eq、lt、gt、not_exist、exist	---
Number	数字	"100"	eq、lt、gt、lte、gte、not_exist、exist	---
Decimal	金额	"100.01"	eq、lt、gt、lte、gte、not_exist、exist	---
Address	地址	{province: "10160", city: "100032", area: "101149"}	in、not_in、not_exist、exist	---
Company	公司	"北京致趣科技"	eq、neq、like、not_like、not_exist、exist	---

search_str

string

搜索

可选

当client_type=mochatLink时，此值支持搜索外部联系人名称和外部联系人id

示例

{
  "client_type": "externalDataSource",
  "nextId": "1027",
  "user_id": "usere19c02bbf14d21e5df2fcd65506b1889",
  "page_num": "1",
  "page_size": "10",
  "condition": [
    {
      "field_name": "obMobile",
      "search_type": "eq",
      "value": "13100029947"
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://openapi.beschannels.com/leads/open-api/data-list-v2?access_token=uURA1lnYsBr22I6UYoLZH0s9y3HU2Xsn7UHA4dIDgHN_67Z5EZskh4YMcymD5enS4GGjWpOERwQtug3Y4AGwvbvLB_A3TwKBpb_J4z0MUm6oaNQmqA-3Ef9Q-PHbVPk3' \
--header 'Content-Type: application/json' \
--data-raw '{
    "client_type":"externalDataSource",
    "nextId":"1027",
    "user_id":"usere19c02bbf14d21e5df2fcd65506b1889",
    "page_num": "1",
    "page_size": "10",
    "condition": [
        {
            "field_name": "obMobile",
            "search_type": "eq",
            "value": "13100029947"
        }
    ]
}'

返回响应

🟢200浏览访客

application/json

Body

code

integer

状态码

必需

msg

string

错误信息

必需

data

object

数据集

必需

total

integer

返回的数据总数

必需

list

array [object {15}]

返回的数据列表

必需

header

array [object {3}]

返回的数据字段列

必需

示例

浏览访客外部数据源

{
  "code": 0,
  "msg": "成功",
  "data": {
    "total": 1,
    "list": [
      {
        "finger_id": "ZQ_6482c1cfJjIDeiPPqHbGPiidfDYdYGclSiYMrHNG",
        "clientip": "211.150.95.62",
        "first_visit_time": "2023-10-31 14:17:46",
        "last_visit_time": "2023-11-23 14:41:58",
        "device": "Computer",
        "browser": "chrome",
        "os": "Mac OS X",
        "id_string": "",
        "group_id": "",
        "static_group_id": "",
        "identity_value": "ZQ_6482c1cfJjIDeiPPqHbGPiidfDYdYGclSiYMrHNG",
        "identity_id": "ZQ_6482c1cfJjIDeiPPqHbGPiidfDYdYGclSiYMrHNG",
        "client_type": "browseCustomers",
        "nextId": "",
        "is_del": ""
      }
    ],
    "header": [
      {
        "label": "浏览器指纹",
        "prop": "finger_id",
        "field_auth": null
      },
      {
        "label": "IP",
        "prop": "clientip",
        "field_auth": null
      },
      {
        "label": "首次访问时间",
        "prop": "first_visit_time",
        "field_auth": null
      },
      {
        "label": "最近访问时间",
        "prop": "last_visit_time",
        "field_auth": null
      },
      {
        "label": "设备",
        "prop": "device",
        "field_auth": null
      },
      {
        "label": "浏览器 ",
        "prop": "browser",
        "field_auth": null
      },
      {
        "label": "操作系统",
        "prop": "os",
        "field_auth": null
      },
      {
        "label": "标签",
        "prop": "id_string",
        "field_auth": null
      },
      {
        "label": "动态分组",
        "prop": "group_id",
        "field_auth": null
      },
      {
        "label": "静态分组",
        "prop": "static_group_id",
        "field_auth": null
      }
    ]
  }
}

🟢200外部数据源数据列表

🟢200留资客户数据列表

🟢200企微外部联系人

修改于 2024-09-23 05:15:12

获取客群对象列表（微信/外部数据源/企微外部联系人）

客群字段列表（外部数据源）

获取客群列表数据-V2（企微外部联系人，外部数据源、留资客户、访客、潜在客户）

接口描述#

接口调用限制为#

请求参数说明#

返回参数说明#

请求参数

示例代码

返回响应

接口描述

接口调用限制为

请求参数说明

返回参数说明