- 开发指南
- 鉴权模块(新)
- 线索
- 标签
- 分组
- 公司
- 扩展对象(业务机会等)
- 表结构
- 客群
- 行为(新)
- 应用中心
- 系统管理
- 资料下载
- 会议管理
- 内容中心
- 会员管理
- 企业微信
- 其他
- 自动化工作流
市场线索列表V2
POST
/leads/open-api/leads-list-v2
客户数据平台(CDP)/线索Leads/高级筛选
最后修改时间:2024-11-29 05:33:56
接口描述#
接口调用限制为#
可获取指定字段返回对应的信息,不指定则默认返回市场线索列表中(该系统用户)当前显示列字段对应的信息
请求参数说明#
参数名称 | 参数类型 | 必须 | 说明 |
---|---|---|---|
user_id | string | 是 | 系统用户的user_id,以该系统用户的数据权限返回数据。获取方法:1.通过 管理员列表接口 获取 2.登录系统获取,位置:个人设置-用户ID |
condition | array | 否 | 数据查询条件,为空则返回所有数据。支持多字段组合筛选,组合关系为 “且”(即返回数据同时满足多字段条件)。 |
field | array | 否 | 返回的数据中包含的字段,为空则返回系统用户在市场线索列表设置的显示列 |
page_num | int | 是 | 页码 |
page_size | int | 是 | 每页条数 |
order | string | 否 | 排序参数,示例:{"field_name": "UpdatedDate","sort": "desc"} 支持字段:创建时间,更新时间,成为线索时间等字段,具体以后台为准 |
返回参数说明#
参数名称 | 说明 |
---|---|
code | 返回码 |
msg | 错误信息 |
data | 数据集 |
返回码说明#
参数名称 | 说明 |
---|---|
-1 | 系统错误 |
0 | 成功 |
10006 | 请输入org_id |
10007 | 请输入user_id |
请求参数
Query 参数
Body 参数application/json
user_id
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
integer | 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 | --- |
邮件 | "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 | --- |
field
array[string]
需要返回的字段列表
page_num
integer
页码
page_size
integer
每页条数
order
string
排序
示例
{
"user_id": "user8fc4611e750b99432c8dd69e35576b75",
"condition": [
{
"field_name": "MobilePhone",
"search_type": "eq",
"value": 18731111311
},
{
"field_name": "FullName",
"search_type": "like",
"value": "12"
}
],
"field": [
"FullName",
"MobilePhone"
],
"page_num":1,
"page_size":20,
"order": {
"field_name": "UpdatedDate",
"sort": "desc"
}
}
示例代码
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/leads-list-v2?access_token=uURA1lnYsBr22I6UYoLZH0s9y3HU2Xsn7UHA4dIDgHN_67Z5EZskh4YMcymD5enS4GGjWpOERwQtug3Y4AGwvbvLB_A3TwKBpb_J4z0MUm6oaNQmqA-3Ef9Q-PHbVPk3' \
--header 'Content-Type: application/json' \
--data-raw '{
"user_id": "user8fc4611e750b99432c8dd69e35576b75",
"condition": [
{
"field_name": "MobilePhone",
"search_type": "eq",
"value": 18731111311
},
{
"field_name": "FullName",
"search_type": "like",
"value": "12"
}
],
"field": [
"FullName",
"MobilePhone"
],
"page_num":1,
"page_size":20,
"order": {
"field_name": "UpdatedDate",
"sort": "desc"
}
}'
返回响应
🟢200成功
application/json
Body
code
integer
返回码
msg
string
错误信息
data
object
数据集
header
array [object {3}]
返回的数据字段列
total
integer
返回的数据总数
list
array [object {5}]
返回的数据列表
示例
{
"code": 0,
"msg": "成功",
"data": {
"header": [
{
"label": "姓名",
"prop": "FullName",
"field_option": []
},
{
"label": "手机号",
"prop": "MobilePhone",
"field_option": []
}
],
"total": 1,
"list": [
{
"id": 106498,
"customer_id": "108ce5d8-b43a-4ba7-3a31-1847579e18af",
"modify_time": 1695190416,
"FullName": "12",
"MobilePhone": "18731111311"
}
]
}
}