文档文章

客户管理 API

客户管理是蝉印诊所管家的核心模块,包含客户建档、画像分析、随访记录管理及照片库等功能。

基础信息

  • 基础路径: /api/customer
  • 认证要求: Bearer Token (Sanctum)
  • 通用响应格式:
    {
      "code": 200,
      "msg": "操作成功",
      "data": { ... }
    }

1. 客户列表

获取所有客户的简略列表,支持权限过滤与分页。

GET /api/customer/index

请求参数

参数名 类型 必填 默认值 描述
rows integer 否 10 每页显示的行数
sort string 否 created_at 排序字段
order string 否 desc 排序方向 (asc/desc)

响应示例

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "rows": [
      {
        "id": 1,
        "name": "张三",
        "sex": 1,
        "idcard": "202501270001",
        "medium_name": "美团预约",
        "tags": [...],
        "created_at": "2025-01-27 10:00:00"
      }
    ],
    "total": 128
  }
}

2. 客户详情 (基础)

获取单个客户的基础档案信息。

GET /api/customer/info

请求参数

参数名 类型 必填 描述
id integer 是 客户系统唯一 ID

3. 用户画像 (深度)

获取客户的综合画像,包括资产状况(余额、累计消费)、标签分类及所属顾问信息。

GET /api/customer/profile

请求参数

参数名 类型 必填 描述
customer_id integer 是 客户 ID

返回数据结构

  • assets : 包含 total_payment (累计支付), balance (储值余额), amount (总积分或可用金额)。
  • affiliations : 包含 consultant (咨询师) 和 ascription (归属人) 信息。

4. 搜索客户

支持通过关键词或精确手机号检索客户。

GET /api/customer/query

请求参数

参数名 类型 必填 可选值 描述
keyword string 是 - 搜索词
category string 是 keyword , phone 搜索类型
rows integer 否 10 分页大小

5. 客户库建档

创建一个新的客户。系统会自动根据规则生成客户卡号。

POST /api/customer/create

JSON 请求体参数

参数名 类型 必填 描述
name string 是 顾客姓名
sex integer 是 性别 (1: 男,2: 女)
phone array 是 手机号数组,支持一客多号
address_id integer 是 联系地址 ID
medium_id integer 是 来源渠道 ID
sfz string 否 身份证号
age integer 否 年龄 (1-199)
birthday string 否 生日 (YYYY-MM-DD)
tags array 否 标签 ID 数组

请求示例

{
  "name": "李四",
  "sex": 2,
  "phone": ["13800138000"],
  "address_id": 101,
  "medium_id": 5,
  "birthday": "1995-05-20",
  "tags": [1, 5]
}

6. 随访记录查询

获取指定客户的历史跟进及随访记录。

GET /api/customer/followup

请求参数

参数名 类型 必填 描述
customer_id integer 是 客户 ID
status integer 否 随访状态过滤

7. 照片影像库

获取客户的治疗前后对比照片或影像资料。

GET /api/customer/photo

请求参数

  • customer_id : 客户 ID
  • rows : 分页大小

相关资源