REST API
API 文檔
使用 EchoPatrol AI API 整合自動化功能到您的系統
認證
所有 API 請求需要在 Header 中包含有效的認證權杖:
Authorization: Bearer <your_access_token>註:您可以在控制台的設定頁面生成 API 金鑰
Base URL
https://echopatrol.exmate.ai認證Authentication
POST
/api/auth/login用戶登入
POST需認證
/api/auth/logout用戶登出
GET需認證
/api/auth/session獲取當前會話
帳號連接Social Accounts
GET需認證
/api/accounts獲取所有已連接帳號
POST需認證
/api/accounts/connect連接新帳號
DELETE需認證
/api/accounts/:id斷開帳號連接
POST需認證
/api/accounts/:id/refresh刷新帳號存取權杖
訊息管理Messages
GET需認證
/api/inbox獲取收件匣訊息
GET需認證
/api/inbox/:id獲取單一訊息詳情
POST需認證
/api/inbox/:id/reply回覆訊息
PATCH需認證
/api/inbox/:id/status更新訊息狀態
AI 回覆AI Replies
POST需認證
/api/ai/generate-reply生成 AI 回覆
GET需認證
/api/review-queue獲取待審核回覆
POST需認證
/api/review-queue批准/拒絕回覆
POST需認證
/api/review-queue/send發送已批准回覆
危機警報Alerts
GET需認證
/api/alerts獲取警報列表
GET需認證
/api/alerts/rules獲取警報規則
POST需認證
/api/alerts/rules建立警報規則
PATCH需認證
/api/alerts/:id/resolve解決警報
AI 潛客開發Prospecting
GET需認證
/api/prospecting獲取潛客列表
POST需認證
/api/prospecting/search搜尋新潛客
POST需認證
/api/prospecting/analyze分析痛點與購買意向
數據分析Analytics
GET需認證
/api/analytics/overview獲取概覽數據
GET需認證
/api/analytics/sentiment獲取情感分析
GET需認證
/api/analytics/engagement獲取互動數據
請求限制
為確保服務穩定性,API 請求有以下限制:
- • 每分鐘 60 次請求(基本方案)
- • 每分鐘 300 次請求(專業方案)
- • 每分鐘 1000 次請求(企業方案)
超過限制將返回 429 Too Many Requests 狀態碼
Webhook 整合
配置 Webhook 以接收即時事件通知:
- •
message.received- 新訊息收到 - •
reply.sent- 回覆已發送 - •
alert.triggered- 警報觸發 - •
prospect.discovered- 發現新潛客