客户高级筛选接口

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

searchKey

string | null

搜索关键字

可选

企业，姓名，备注名，昵称，电话

customerType

integer | null

客户模式

可选

1:个人模式 2:企业客户模式 3:混合模式(个人客户+企业客户)

customerAllocateSource

null

客户来源

可选

1表示公海领取，2表示公司分配，3表示自己添加，4表示转移添加，5表示好友创建

protectedTime

integer | null

是否锁定客户

可选

0:不锁定,1:锁定

conditions

object | null

高级筛选组

可选

标签,商机暂不支持,积分、评分筛选条件类型按4查询

isEmty

boolean | null

高级筛选时填写false，否则不写

可选

conditionOp

integer

高级筛选条件组合规则

可选

0表示且，1表示或高级筛选时必填

conditionItems

array [object {4}] | null

高级筛选条件组

可选

pageSize

integer | null

页大小

可选

默认30

pageNo

integer | null

页数

可选

默认1

sortField

string | null

排序字段

可选

friendType

string | null

按好友关系查询

可选

1未添加,2已申请,3已添加,4客户主动删除,5员工主动删除,参数格式为[4,5]

obtainWay

string | null

按获取途径查询客户

可选

1,公海领取2,公司分配3,个人领取4,转移接收5,好友创建,参数格式为[4,5]

示例

{
    "searchKey": "",
    "customerType": 3,
    "repoId": null,
    "customerAllocateSource": null,
    "protectedTime": 0,
    "conditions": {
        "isEmty": false,
        "conditionOp": 0,
        "conditionItems": [
            {
                "name": "别动单选",
                "op": 2,
                "fieldType": 2,
                "values": [
                    "权重"
                ]
            },
            {
                "name": "客户来源",
                "op": 2,
                "fieldType": 2,
                "values": [
                    "老客户介绍"
                ]
            }
        ]
    },
    "pageSize": 50,
    "pageNo": 1,
    "sortField": "create_time",
    "sortDir": 1
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/api/v3/customer/list-customer-of-search' \
--header 'appId;' \
--header 'timestamp;' \
--header 'sign;' \
--header 'appKey: {{appKey}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "searchKey": "",
    "customerType": 3,
    "repoId": null,
    "customerAllocateSource": null,
    "protectedTime": 0,
    "conditions": {
        "isEmty": false,
        "conditionOp": 0,
        "conditionItems": [
            {
                "name": "别动单选",
                "op": 2,
                "fieldType": 2,
                "values": [
                    "权重"
                ]
            },
            {
                "name": "客户来源",
                "op": 2,
                "fieldType": 2,
                "values": [
                    "老客户介绍"
                ]
            }
        ]
    },
    "pageSize": 50,
    "pageNo": 1,
    "sortField": "create_time",
    "sortDir": 1
}'

返回响应

🟢200成功

application/json

Body

code

integer

调用响应码

必需

message

string

响应结果

必需

data

object

返回数据

必需

totalCount

integer

总条数

必需

totalPage

integer

总页数

必需

pageNo

integer

当前页

必需

pageSize

integer

页大小

必需

data

array [object {74}]

相应数据

必需

示例

{
    "code": 0,
    "message": "string",
    "data": {
        "totalCount": 0,
        "totalPage": 0,
        "pageNo": 0,
        "pageSize": 0,
        "data": [
            {
                "30744": [
                    "string"
                ],
                "create_time": "string",
                "qw_last_follow_time": "string",
                "get_create_time": "string",
                "protected_time": 0,
                "customer_sales_info_id": 0,
                "group_size": 0,
                "sales_id": 0,
                "customer_id": 0,
                "qw_sales_id": "string",
                "external_user_id": "string",
                "externalUserId": "string",
                "is_customer": 0,
                "wechat_nickname": "string",
                "wechat_avatar": "string",
                "sales_stage": 0,
                "sales_stage_name": "string",
                "sales_stage_sub": null,
                "sales_stage_sub_name": null,
                "sales_stage_end": null,
                "sales_stage_end_name": null,
                "content_type": null,
                "union_id": "string",
                "location": "string",
                "salesName": "string",
                "sales_deleted": true,
                "share_first": null,
                "shield": null,
                "qw_remark": "string",
                "customer_abandon": null,
                "customer_abandon_reason": null,
                "abandon_time": null,
                "customerRecovery": "string",
                "birthday": "string",
                "role": "string",
                "customer_status": 0,
                "is_friend": true,
                "customer_type": 0,
                "corp_name": null,
                "corp_name_short": null,
                "last_follow_user_id": 0,
                "last_follow_user_name": "string",
                "company_id": null,
                "protect": 0,
                "protectedTime": 0,
                "group_list": [
                    "string"
                ],
                "sign_num": 0,
                "sendChatCount": 0,
                "replyChatCount": 0,
                "phone_repeat": true,
                "follow_repeat": true,
                "request_sent": true,
                "last_request_sent": null,
                "customer_allocate_source": 0,
                "qw_customer_time": "string",
                "tags": [
                    "string"
                ],
                "tagIds": [
                    0
                ],
                "pvTagId": [
                    "string"
                ],
                "contentTags": [
                    "string"
                ],
                "id": 0,
                "share_source": 0,
                "deleteStatus": 0,
                "area_id": 0,
                "customer_repo_id": 0,
                "area_value": "string",
                "pointCredit": null,
                "pointScore": null,
                "channel_state": null,
                "main_follows": [
                    {
                        "sales_id": 0,
                        "sales_name": "string",
                        "sales_avatar": "string"
                    }
                ],
                "share_follows": [
                    {
                        "sales_id": 0,
                        "sales_name": "string",
                        "sales_avatar": "string"
                    }
                ],
                "open_sea_time": "string",
                "add_way": "string",
                "add_way_name": "string",
                "state ": "string"
            }
        ]
    }
}

🟢200异常