Bes_Open_API
  1. 客群
Bes_Open_API
  • 开发指南
    • 产品概述
    • 通用项&参数说明
    • 更新日志
  • 鉴权模块(新)
    • openapi-获取token
      POST
  • 线索
    • 市场线索列表V2
      POST
    • 新增/编辑线索
      POST
    • 删除线索
      POST
    • 获取备注列表
      POST
    • 获取线索详情
      POST
    • 新增跟进记录
      POST
    • 获取线索行为事件
      POST
    • 获取线索行为记录
      POST
    • 获取线索分值记录
      POST
    • 市场线索-变更归属人
      POST
    • 批量获取线索分值记录
      POST
    • 表单管理列表
      POST
    • 表单提交数据列表
      POST
    • 获取线索来源
      POST
    • 获取接口数据处理状态(API接口数据)
      POST
  • 标签
    • 标签管理-分组列表
      POST
    • 标签管理-分组创建
      POST
    • 标签管理-分组编辑/删除
      POST
    • 标签管理-标签列表
      POST
    • 标签管理-标签创建
      POST
    • 标签管理-标签/编辑/移动
      POST
    • 对象打标签&移除标签
      POST
    • 获取对象和对象标签(对象ID必传)
      POST
    • 获取对象所有打标签流水(打标签时间倒序)
      POST
  • 分组
    • 分组列表
    • 分组下用户列表
    • 获取对象列表
    • 市场线索移入/移出分组
  • 公司
    • 公司列表V2
    • 公司编辑(单字段)
    • 公司创建
  • 扩展对象(业务机会等)
    • 对象列表
    • 新增/编辑对象
    • 删除对象
    • 记录类型-全部列表
    • 记录类型-根据当前账号权限返回可以的列表
  • 表结构
    • 表结构列表
    • 表结构详情
  • 客群
    • 新增/编辑客群数据(仅支持外部数据源)
      POST
    • 获取客群对象列表(微信/外部数据源/企微外部联系人)
      POST
    • 获取客群列表数据-V2(企微外部联系人,外部数据源、留资客户、访客、潜在客户)
      POST
    • 客群字段列表(外部数据源)
      GET
  • 行为(新)
    • 新增应用
    • 获取应用
    • 添加事件
    • 获取事件
    • 添加事件属性
    • 获取事件属性
    • 添加属性选项值
    • 添加用户行为
    • 事件关联事件属性
    • 获取所有自定义事件属性
    • 获取浏览访客行为记录
  • 应用中心
    • 公众号管理
      • 获取微信授权链接
      • 根据微信code获取粉丝信息
      • 根据open_id,批量获取粉丝信息
      • 获取微信公众号列表
      • 获取粉丝信息
      • 获取取关粉丝信息
  • 系统管理
    • 获取某个用户信息
    • 获取组织信息
    • 自定义渠道-渠道列表
    • 获取管理员列表
    • 删除管理员
  • 资料下载
    • 资料下载-列表
  • 会议管理
    • 会议管理-列表数据
    • 会议管理-获取报名数据
    • 会议管理-获取签到参会数据
    • 获取分类列表(支持会议管理&资料下载)
    • 会议管理-会议报名
    • 会议管理-会议签到
    • 会议管理-获取会议详情
  • 内容中心
    • 获取内容分类
    • 获取内容列表
    • 获取内容详情
  • 会员管理
    • 会员管理-获取基础信息
    • 会员管理-获取自定义字段
    • 会员管理-变更积分
    • 根据会员id或会员手机号获取会员详细信息
    • 会员/员工(注册/更新)
    • 根据地区名称查询地区id
    • 获取会员/员工列表
    • 根据openid获取会员/员工信息
    • 会员管理-删除会员
  • 企业微信
    • 绑定外部联系人手机&邮箱&unionid
  • 其他
    • 错误码
  • 自动化工作流
    • 关闭工作流
    • 工作流列表
  1. 客群

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

POST
/leads/open-api/data-list-v2
最后修改时间:2024-09-23 05:15:12

接口描述#

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

接口调用限制为#

每秒50次。

请求参数说明#

通用参数 access_token (使用 鉴权模块-获取token接口 获取)
参数名称参数类型必须说明
user_idstring是系统用户的user_id,以该系统用户的数据权限返回数据。获取方法:1.通过 管理员列表接口 获取 2.登录系统获取,位置:个人设置-用户ID
conditionarray否数据查询条件,为空则返回所有数据。支持多字段组合筛选,组合关系为 “且”(即返回数据同时满足多字段条件)。
client_typeint是browseCustomers=浏览访客,externalDataSource=外部数据,clientsCustomers=留资客户,mochatLink=企微外部联系人
nextIdint否当client_type=externalDataSource,或者=mochatLink时,此值必传,值为表结构ID。通过 获取客群对象列表,参数customersField获取
page_numint是页码
page_sizeint是每页条数
condition_typestring否多个条件的组合关系,默认为and。and:条件组合为and关系 or:条件组合为or关系
search_strstring否模糊查询参数
注:当client_type=browseCustomers时,支持按 first_visit_time(第一次访问时间)/last_visit_time(最后一次访问时间)字段组合查询,字段类型为DateTime

返回参数说明#

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

请求参数

Query 参数
access_token
string 
必需
示例值:
{{access_token}}
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!=(不等于)
likelike(包含)
not_likenot_like (不包含)
not_existnot_exist(为空)
existexist (不为空)
inin (包含任意)
not_innot_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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
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企微外部联系人
上一页
获取客群对象列表(微信/外部数据源/企微外部联系人)
下一页
客群字段列表(外部数据源)
Built with