5-MINUTE QUICKSTART

送出第一則通知

不必先理解所有功能。建立測試環境、啟用一個通道、建立 API 金鑰,即可送出第一則可追蹤的通知。

STEP 01

建立測試環境

以工作 Email 完成驗證,系統會建立獨立公司空間與管理員帳號。

STEP 02

啟用通知通道

在公司與通道頁加入 LINE、Email、SMS 或其他供應商憑證,並執行連線測試。

STEP 03

建立 API 金鑰

在 API 金鑰頁建立金鑰。明文只顯示一次,請立即存入安全的秘密管理工具。

呼叫統一發送 API

API 金鑰已綁定公司,不必在 request body 重複傳送公司代碼。以下範例一次發送 LINE 與 SMS,並用 requestId 避免重複送出。

curl -X POST "$NOTIFYFLOW_URL/api/notifications/send" \
  -H "Authorization: Bearer $NOTIFYFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "targets": [
      { "channel": "LINE", "recipient": "U123..." },
      { "channel": "SMS", "recipient": "+886912345678" }
    ],
    "body": "您的預約已確認",
    "requestId": "appointment-20260929-001"
  }'

成功回應

{
  "success": true,
  "data": {
    "sent": 2,
    "allFailed": false,
    "results": [
      { "channel": "LINE", "status": "SENT", "messageId": "..." },
      { "channel": "SMS", "status": "SENT", "messageId": "..." }
    ]
  }
}
HTTP 200 表示請求已完成處理;每一個通道的實際結果請查看 data.results[].status。供應商拒絕、逾時或濫用防護攔截時,錯誤原因也會保留在個別結果與後台發送記錄。