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 - 發現新潛客
查看 Webhook 文檔 →