跳到主要内容

REST API 参考

所有 API 端点以 /api/ 为前缀,需要通过会话 cookie 进行身份验证。所有请求和响应使用 Content-Type: application/json


对话

端点方法描述
/api/conversationsGET列出对话(过滤器:status、channel_type、tag、search、page)
/api/conversations/{id}GET获取对话(重置 unread_count)
/api/conversationsPOST创建对话
/api/conversations/{id}/statusPOST更新状态
/api/conversations/{id}/tagsPOST添加标签
/api/conversations/{id}/tags/{tag}DELETE移除标签
/api/conversations/{id}/assignPOST分配客服

消息

端点方法描述
/api/conversations/{id}/messagesGET列出消息
/api/conversations/{id}/messagesPOST发送消息

AI 建议

端点方法描述
/api/ai-suggest?conversation_id={id}GET获取 AI 回复建议

联系人

端点方法描述
/api/contactsGET列出联系人
/api/contacts/{id}GET获取联系人
/api/contactsPOST创建联系人
/api/contacts/{id}PATCH更新联系人
/api/contacts/{id}DELETE删除联系人(管理员)

渠道(仅管理员)

端点方法描述
/api/channelsGET列出渠道
/api/channelsPOST创建渠道
/api/channels/{id}PATCH更新渠道
/api/channels/{id}DELETE删除渠道

自动化(仅管理员)

端点方法描述
/api/automationsGET列出自动化
/api/automationsPOST创建自动化
/api/automations/{id}/togglePOST切换启用/禁用
/api/automations/{id}DELETE删除自动化

分析

端点方法描述
/api/analytics?days=30GET获取分析数据

客服(仅管理员)

端点方法描述
/api/agentsGET列出客服
/api/agentsPOST创建客服
/api/agents/{id}/rolePOST更新角色
/api/agents/{id}DELETE删除客服

设置

端点方法描述
/api/settings/workspaceGET获取工作区设置
/api/settings/workspacePOST更新工作区(管理员)
/api/settings/passwordPOST修改密码

错误格式

{"error": "Human-readable error message"}
代码含义
200成功
201已创建
400错误请求
401未认证
403禁止访问
404未找到
409冲突
500内部错误