📚 API 文档

客徕徕智能工作手机 RESTful API 接口文档

支持 MCP (Model Context Protocol) 自动化操作

🚀 快速开始

基础信息

API 基础地址:

https://api.kelailai.com/v1

测试环境:

https://api-test.kelailai.com/v1

请求格式

响应格式

{ "success": true, "data": { "id": "123", "name": "客户名称" }, "error": null }

🔐 认证授权

登录获取 Token

POST /user/login

使用账号密码登录,获取访问令牌

请求参数

参数名 类型 必填 说明
account string 登录账号
password string 登录密码
clientType string 'client' 客户端(8h) 或 'server' 管理端(24h)

请求示例

POST /user/login Content-Type: application/json { "account": "admin@kelailai.com", "password": "your_password", "clientType": "server" }

响应示例

{ "success": true, "data": { "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "userId": "user_123", "expiresIn": 86400 } }

使用 Token

获取 Token 后,在所有后续请求的 Header 中携带:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

⭐ 核心优势

🔐 细粒度权限管理

多账号同时管理同一微信,支持按标签、分组授权,权限颗粒度更细,数据安全有保障

🤖 强大自动化能力

自动采集用户信息、智能标签系统、自动化消息回复,解放人力提升效率

🧠 AI智能赋能

AI客服、风险管控预警、AI数据分析,让企业决策更智能

🔄 完整业务闭环

会员管理+营销工具+门店管理+库存管理,一站式解决方案

功能对比

功能特性 客徕徕 其他SCRM
多账号管理同一微信 ✓ 支持 ✗ 不支持
按标签/分组授权 ✓ 细粒度权限 △ 仅账号级
自动采集用户信息 ✓ 全自动 △ 需手动
智能标签系统 ✓ 自动打标签 △ 手动标签
AI客服 ✓ 内置AI ✗ 无
风险管控 ✓ AI预警 ✗ 无
AI数据分析 ✓ 智能分析 △ 基础报表
MCP协议支持 ✓ 完整支持 ✗ 不支持
业务闭环 ✓ 会员+营销+门店+库存 △ 仅客户管理
行业适配 ✓ 20+行业1200+企业 △ 特定行业

🏢 行业覆盖

客徕徕已服务20+行业超1200家企业,从小微商户到大型企业均可使用

💎 水晶手串

120-60家企业

⚙️ 机电

150+家企业

🧬 生物医药

10-20家企业

💰 金融

20-50家企业

🏠 房产

10-30家企业

🍽️ 餐饮

10-50家企业

🧹 家政

20-60家企业

🪑 家具

20家企业

📺 传媒广告

30家企业

🎓 教育

60家企业

💻 科技

10家企业

👔 人力资源

20家企业

🏨 酒店

20-200家企业

📦 物流

10家企业

🚗 汽车

20家企业

💊 大健康

30-50家企业

📢 营销

20家企业

🛒 电商

20-100家企业

⚖️ 法务

20-40家企业

🔨 装修

10-20家企业

典型应用场景

🏪 连锁门店场景

某连锁餐饮品牌,50家门店,每店配置独立子账号管理本店客户,总部可查看全局数据。通过自动化标签识别"高频消费客户"、"沉睡客户",精准推送优惠券,复购率提升40%

🤝 代理商场景

某机电设备代理商,管理200+经销商客户。通过按标签授权,华东区销售只能看到华东客户,华南区销售只能看到华南客户,避免客户信息泄露。AI客服自动回答产品参数问题,客服效率提升60%

🏢 大型企业场景

某金融集团,10个业务部门共用企业微信。通过细粒度权限管理,理财部门只能管理"理财客户"标签,保险部门只能管理"保险客户"标签。风险管控系统实时监测敏感词,合规风险降低80%

🤖 MCP 集成

什么是 MCP?

MCP (Model Context Protocol) 是一个开放协议,允许 AI 模型(如 Claude、ChatGPT)通过标准化接口与外部系统交互。 客徕徕 API 完全支持 MCP 协议,可以让 AI 助手自动化执行客户管理、消息发送等操作。

MCP 配置示例

在 MCP 配置文件中添加客徕徕服务器:

{ "mcpServers": { "kelailai": { "command": "npx", "args": ["-y", "@kelailai/mcp-server"], "env": { "KELAILAI_API_KEY": "your_api_token", "KELAILAI_API_BASE": "https://api.kelailai.com/v1" } } } }

MCP 支持的操作

操作 MCP 工具名称 说明
查询客户列表 kelailai_list_customers 获取客户列表,支持筛选和分页
获取客户详情 kelailai_get_customer 获取指定客户的详细信息
发送消息 kelailai_send_message 向客户或群组发送消息
添加标签 kelailai_add_tag 为客户添加标签
查询数据统计 kelailai_get_statistics 获取客户、消息等数据统计

MCP 使用示例

示例 1:查询客户

"帮我查询最近添加的 10 个客户"

示例 2:发送消息

"给标签为'VIP客户'的所有客户发送一条促销消息"

示例 3:数据分析

"统计本月新增客户数量和活跃客户数"

💡 提示:MCP 集成让 AI 助手能够理解自然语言指令并自动调用相应的 API,大幅提升工作效率。

👥 客户管理 API

获取客户列表

GET /customers

获取客户列表,支持按标签、分组筛选和分页

查询参数

参数名 类型 必填 说明
page number 页码,默认1
limit number 每页数量,默认20
tags string[] 标签筛选,支持多个标签
groupId string 分组ID筛选
keyword string 关键词搜索(昵称、备注)

响应示例

{ "success": true, "data": { "list": [ { "id": "customer_123", "nickname": "张三", "avatar": "https://...", "tags": ["VIP客户", "华东区"], "groupId": "group_001", "createTime": 1640000000000, "lastContactTime": 1640100000000 } ], "total": 150, "page": 1, "limit": 20 } }

添加客户标签

POST /customers/{customerId}/tags

为指定客户添加标签,支持自动化标签和手动标签

请求参数

参数名 类型 必填 说明
tags string[] 标签名称数组
autoTag boolean 是否为自动标签,默认false

请求示例

POST /customers/customer_123/tags Authorization: Bearer your_token Content-Type: application/json { "tags": ["高价值客户", "7天活跃"], "autoTag": true }

💬 消息管理 API

发送消息

POST /messages/send

向客户或群组发送消息,支持文本、图片、文件等多种类型

请求参数

参数名 类型 必填 说明
toUserId string 接收者ID(客户或群组)
msgType string 消息类型:text/image/file/video
content string 消息内容或媒体URL
autoReply boolean 是否为自动回复,默认false

请求示例

POST /messages/send Authorization: Bearer your_token Content-Type: application/json { "toUserId": "customer_123", "msgType": "text", "content": "您好,您的订单已发货", "autoReply": false }

配置自动回复

POST /auto-reply/rules

配置自动回复规则,支持关键词触发、时间触发等多种场景

请求参数

参数名 类型 必填 说明
ruleName string 规则名称
triggerType string 触发类型:keyword/time/event
keywords string[] 关键词列表(triggerType=keyword时必填)
replyContent string 回复内容
enabled boolean 是否启用,默认true

🔐 权限管理 API

创建子账号

POST /accounts/sub-accounts

创建子账号并配置细粒度权限(按标签、分组授权)

请求参数

参数名 类型 必填 说明
username string 子账号用户名
password string 初始密码
permissions object 权限配置
permissions.allowedTags string[] 允许访问的标签列表
permissions.allowedGroups string[] 允许访问的分组列表
permissions.canSendMessage boolean 是否允许发送消息
permissions.canViewStatistics boolean 是否允许查看统计数据

请求示例

POST /accounts/sub-accounts Authorization: Bearer your_token Content-Type: application/json { "username": "sales_east", "password": "initial_password", "permissions": { "allowedTags": ["华东区", "VIP客户"], "allowedGroups": ["group_001"], "canSendMessage": true, "canViewStatistics": false } }
💡 细粒度权限优势:子账号只能看到和管理被授权的客户,避免数据泄露。例如:销售A只能看到"华东区"标签的客户,销售B只能管理"VIP会员"分组。

🧠 AI功能 API

AI客服对话

POST /ai/chat

调用AI客服进行智能对话,自动回答客户问题

请求参数

参数名 类型 必填 说明
customerId string 客户ID
message string 客户消息内容
context object 上下文信息(历史对话等)

风险管控检测

POST /ai/risk-detection

AI风险管控,实时检测敏感词、异常行为等风险

请求参数

参数名 类型 必填 说明
content string 待检测内容
type string 检测类型:message/behavior

响应示例

{ "success": true, "data": { "riskLevel": "high", "riskType": "sensitive_word", "details": "检测到敏感词:转账、私下交易", "suggestion": "建议人工介入处理" } }

AI数据分析

GET /ai/analytics

AI智能分析客户数据,生成洞察报告

查询参数

参数名 类型 必填 说明
startDate string 开始日期 YYYY-MM-DD
endDate string 结束日期 YYYY-MM-DD
metrics string[] 分析指标:customer_growth/activity/conversion

响应示例

{ "success": true, "data": { "insights": [ { "metric": "customer_growth", "value": 150, "trend": "up", "analysis": "本月新增客户150人,环比增长25%,主要来源于线上推广" }, { "metric": "activity", "value": 0.68, "trend": "stable", "analysis": "客户活跃度68%,建议对30天未互动客户进行唤醒营销" } ], "recommendations": [ "建议增加'高价值客户'标签的营销投入", "建议优化自动回复规则,提升响应速度" ] } }

❓ 常见问题

Q1: 客徕徕支持哪些行业?

A: 客徕徕已服务20+行业超1200家企业,包括水晶手串、机电、生物医药、金融、房产、餐饮、家政、教育、电商、酒店等全行业领域。从小微商户到大型企业均可使用。

Q2: 客徕徕与其他SCRM系统相比有什么优势?

A: 核心优势包括:1) 多账号管理同一微信,支持按标签/分组授权,权限颗粒度更细;2) 自动化能力强(自动采集用户信息、自动打标签、自动回复消息);3) AI客服+风险管控+AI数据分析三大智能功能;4) 完整业务闭环(会员+营销+门店+库存管理)。

Q3: 如何实现多账号管理同一微信?

A: 通过创建子账号并配置细粒度权限,可以让多个子账号同时管理同一个企业微信。例如:销售A只能看到"华东区"标签的客户,销售B只能管理"VIP会员"分组,实现精细化权限控制。

Q4: 客徕徕的自动化功能包括哪些?

A: 三大自动化能力:1) 自动采集用户基础信息(昵称、头像、地区、来源等);2) 智能标签系统,根据用户行为自动打标签(如"高价值客户"、"7天未互动");3) 自动化消息回复,支持关键词触发、时间触发、事件触发等多种场景。

Q5: 客徕徕API支持MCP协议吗?

A: 是的,客徕徕完全支持MCP (Model Context Protocol) 协议,可以让Claude、ChatGPT等AI助手通过自然语言指令自动化执行客户管理、消息发送、数据分析等操作,大幅提升工作效率。

Q6: AI客服能解决哪些问题?

A: AI客服可以自动回答常见问题(产品参数、价格、售后政策等),识别客户意图并推荐合适的产品或服务,处理简单的售后咨询。对于复杂问题会自动转人工客服,确保服务质量。

Q7: 风险管控功能如何工作?

A: AI风险管控系统实时监测聊天内容,识别敏感词(如"转账"、"私下交易")、异常行为(如频繁删除好友、大量群发消息),并及时预警。帮助企业降低合规风险,保护客户数据安全。

Q8: Token有效期是多久?

A: 客户端Token有效期8小时,管理端Token有效期24小时。Token过期后需要重新登录获取新Token。建议在Token过期前主动刷新。

开始使用客徕徕 API

完整的 API 文档和更多示例

下载客户端 查看帮助