REST API

了解如何整合和使用 EngageLab SMS REST API。

EngageLab SMS 服務提供了一組 RESTful API，允許您透過程式設計方式建立範本和簽名、發送簡訊並查詢餘額。

請按照以下步驟開始使用 REST API。

建立 API Key

在呼叫任何 EngageLab SMS API 之前，您需要產生一個 API Key 來對您的請求進行身分驗證。

1. 登入 EngageLab 控制台。
2. 進入 SMS 子控制台並選擇您的應用程式。
3. 在左側導覽列中導覽至 API Keys。
4. 點擊 Create API Key 產生新的 dev_key 和 dev_secret。

⚠️ 警告
您的 dev_secret 高度敏感。請務必妥善保管，切勿在用戶端程式碼或公開的程式碼庫中洩露。

身分驗證

EngageLab SMS API 使用 HTTP Basic 身分驗證。您必須在所有 API 請求中包含 Authorization 請求標頭。

該請求標頭是使用您的 dev_key 和 dev_secret 進行 Base64 編碼建構的：

              
              Authorization: Basic ${base64_auth_string}

            

${base64_auth_string} 是將您的 dev_key 和 dev_secret 透過冒號（:）連接後進行 Base64 編碼產生的：base64(dev_key:dev_secret)。

有關更多詳細資訊，請參閱 身分驗證 指南。

呼叫 API

獲得 API Key 並了解身分驗證機制後，您就可以開始呼叫 API 了。所有 API 端點都使用基礎 URL https://smsapi.engagelab.com。

以下是您可以整合的幾個主要 API：

• 發送簡訊：向單個或多個目標手機號碼發送簡訊，支援自動化發送通知和行銷簡訊。
• 查詢餘額：透過 API 介面即時查詢 EngageLab SMS 帳戶可用餘額，包含普通餘額與贈送餘額資訊。
• 範本管理：透過程式設計方式建立、修改、刪除、取得所有的範本列表以及查看範本詳情。
• 簽名管理：透過程式設計方式建立、修改、刪除、取得所有的簽名列表以及查看簽名詳情。
• 回呼事件參考：設定回呼網址並使用安全校驗機制接收狀態報告和通知。
• SMPP：使用 SMPP 協定透過 TCP 連線實現高效、可靠的訊息下發和狀態回報。