蝉印

主题

客户管理 API ​

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

基础信息 ​

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

1. 客户列表 ​

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

GET /api/customer/index ​

请求参数

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

响应示例

json
{
  "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 ​

请求参数

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

3. 用户画像 (深度) ​

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

GET /api/customer/profile ​

请求参数

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

返回数据结构

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

4. 搜索客户 ​

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

GET /api/customer/query ​

请求参数

参数名类型必填可选值描述
keywordstring是-搜索词
categorystring是keyword , phone搜索类型
rowsinteger否10分页大小

5. 客户库建档 ​

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

POST /api/customer/create ​

JSON 请求体参数

参数名类型必填描述
namestring是顾客姓名
sexinteger是性别 (1: 男，2: 女)
phonearray是手机号数组，支持一客多号
address_idinteger是联系地址 ID
medium_idinteger是来源渠道 ID
sfzstring否身份证号
ageinteger否年龄 (1-199)
birthdaystring否生日 (YYYY-MM-DD)
tagsarray否标签 ID 数组

请求示例

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

6. 随访记录查询 ​

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

GET /api/customer/followup ​

请求参数

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

7. 照片影像库 ​

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

GET /api/customer/photo ​

请求参数

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

相关资源 ​