Appearance

获取客户列表总数 ​

拥有此API的权限集
SCRM-客户管理

请求方式及url ​

  • 请求方式：POST
  • 请求头：Content-Type:application/json
  • 接口地址：https://api.xiaoe-tech.com/xe.scrm.customer.total/1.0.0
  • 频率限制：1s/1次

接口调试

请求参数
响应结果
暂无响应数据

请求参数 ​

请求参数与客户列表一致，包括 corp_id、page、page_size、display_fields 和 filters 下的全部筛选字段。page、page_size、display_fields 不影响总数计算。

filters.source.channels 传入渠道原始 ID，接口会自动拼接 s_ 前缀。

参数名必选类型说明
access_token是string专属token
corp_id是string企业 ID，必须为当前店铺绑定的有效企业
page否int与客户列表请求保持一致，不影响总数
page_size否int与客户列表请求保持一致，不影响总数
display_fields否array<string>与客户列表请求保持一致，不影响总数
filters否object与客户列表相同的客户筛选条件

请求示例 ​

json
{
  "access_token": "xe_xxxxx",
  "corp_id": "corp_xxx",
  "filters": {
    "search_type": "customer_name",
    "keyword": "客户示例",
    "follow_user_ids": ["staff_1"],
    "status": {
      "customer_churn_states": ["0"]
    }
  }
}

返回参数 ​

参数名类型说明
codeint状态码，0 表示成功，非 0 表示失败
msgstring状态信息
dataobject返回数据
data.totalint64与客户列表相同筛选条件下的客户跟进关系总数

返回示例 ​

json
{
  "code": 0,
  "msg": "ok",
  "data": {
    "total": 42
  }
}