获取客户列表 - SaleSmartly

请求参数

Query 参数

page_size

string

可选

每页展示数量（最大为100）

示例值:

50

page

string

页数

可选

示例值:

1

type

string

可选

客户类型（全部客户：all_user ，有效客户：valid_user）

project_id

string

项目ID

必需

示例值:

abc1d1

next_token

string

可选

翻页所需的Token（和page参数不可以同时使用）

示例值:

CAESFAoSChAKDGNyZWF0ZWRfdGltZRABGAEiRAoJAD0nw2QAAAAACjcDMgAAADFTMzYzNDYzMzMzMjM3MzM2NDMwMzczOTM0MzQzMDM3MzMzNjM5MzQzOTY1NjI2NjMx

channel

string

可选

渠道（1-Messenger 2-聊天插件 3-Email 4-Telegram Bot 5-Instagram 6-Line 7-WhatsApp Api 8-Facebook主页评论 10-Slack 11-企业微信 12-whatsapp App 13-instagram评论 15-telegram App）

示例值:

1

country

string

国家

可选

city

string

城市

可选

language

string

语言

可选

is_online

string

可选

在线状态（0 离线，1在线）

created_time

string

创建时间

可选

示例值:

{"start": 1638288000, "end": 1638892800}

query

string

复合查询结构

可选

示例值:

[{"field":"phone","condition":"empty","value":""}]

advanced_query

string

可选

condition(isset 有值， contain 包含，not_contain 不包含，empty 空，between 区间， not_between 不在区间)

示例值:

[{"field":"phone","condition":"empty","value":""}]

label_ids

string

可选

标签id,多个以,分隔

ids

string

可选

用户id,多个以,分隔

field_sort

string

排序

可选

示例值:

{"created_time": "ASC", "msg_last_send_time": "DESC"}

user_type

string

可选

有效客户类型（全部有效客户 valid_all，有消息客户 valid_chat，有下单客户 valid_order，无下单客户 valid_unorder）

advanced_query_type

string

可选

高级筛选类型（and 且， or 或）

user_id

string

接待人

可选

module

string

可选

模块。当是消息群发模块时传 message_broadcast

channel_id

string

所属社媒渠道的id

可选

channel_uids

string

可选

客户的社媒渠道id（支持最多十个批量查询用 , 分隔）

updated_time

string

客户更新时间

必需

示例值:

{"start":1680000000,"end":1714027206}

Header 参数

external-sign

string

必需

发送请求所需签名(签名是以参数名称按字典序排序后衔接到token进行MD5加密后的值)，详情查看：https://help.salesmartly.com/docs/API-Header

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request GET 'https://api.salesmartly.com/api/chat-user/get-contact-list?page_size=50&page=1&type=&project_id=abc1d1&next_token=CAESFAoSChAKDGNyZWF0ZWRfdGltZRABGAEiRAoJAD0nw2QAAAAACjcDMgAAADFTMzYzNDYzMzMzMjM3MzM2NDMwMzczOTM0MzQzMDM3MzMzNjM5MzQzOTY1NjI2NjMx&channel=1&country=&city=&language=&is_online=&created_time={"start": 1638288000, "end": 1638892800}  &query=[{"field":"phone","condition":"empty","value":""}]&advanced_query=[{"field":"phone","condition":"empty","value":""}]&label_ids=&ids=&field_sort={"created_time": "ASC", "msg_last_send_time": "DESC"}&user_type=&advanced_query_type=&user_id=&module=&channel_id=&channel_uids=&updated_time={"start":1680000000,"end":1714027206}' \
--header 'external-sign;'

返回响应

🟢200成功

application/json

Body

data

object

必需

list

array [object {27}]

必需

total

integer

客户总数

必需

page

integer

当前页数

必需

page_size

integer

页数大小

必需

next_token

string

下一页的token

必需

count

object

必需

code

integer

必需

msg

string

必需

示例

{
  "data": {
    "list": [
      {
        "channel": "string",
        "name": "string",
        "remark_name": "string",
        "email": "string",
        "phone": "string",
        "country": "string",
        "city": "string",
        "language": "string",
        "labels": "string",
        "is_online": "string",
        "remark": "string",
        "created_time": "string",
        "channel_id": "string",
        "order_cnt": "string",
        "order_amount": "string",
        "msg_cnt": "string",
        "session_cnt": "string",
        "msg_last_send_time": "string",
        "sys_user_id": "string",
        "channel_info": "string",
        "chat_type": "string",
        "user_last_reply_time": "string",
        "chat_user_id": "string",
        "sys_user_name": "string",
        "content": "string",
        "channel_name": "string",
        "channel_phone": "string"
      }
    ],
    "total": 0,
    "page": 0,
    "page_size": 0,
    "next_token": "string"
  },
  "count": {},
  "code": 0,
  "msg": "string"
}