Logo Site EngageLab Mark Colored Transparent文件
搜尋

AI Agent OTP API

AI Agent 發送和驗證 OTP 所需的一切 — 幾分鐘內即可啟動並運行。

EngageLab OTP API 允許您的 AI Agent 透過統一的多通道 API(SMS、WhatsApp、Email 和 Voice)發送和驗證一次性密碼 (OTP)。全過程透過程式化呼叫完成,無需任何人工干預。

準備工作:建立 API Key 和範本

在您的 Agent 可以發送 OTP 之前,需要在 EngageLab 控制台中由人工完成兩個一次性的設定步驟。

1. 建立 API Key
註冊 EngageLab 帳號並在 OTP 控制台中建立 API Key。系統將生成一組 dev_keydev_secret,您的 Agent 將使用它們來對所有 API 請求進行身份驗證。

2. 建立並審核範本
每條 OTP 訊息都會使用預先審核通過的範本發送。在控制台中建立範本,設定您的發送通道(如 SMS、WhatsApp、Email 或 Voice)、驗證碼長度和有效期。範本需要經過審核才能使用。審核通過後,將 Template ID (範本 ID) 作為參數傳遞給您的 Agent。

Agent Skills — 如何安裝 EngageLab OTP Agent Skills?

Agent Skills 賦予 Cursor、Claude Code 和 Windsurf 自動處理 OTP 的能力:發送驗證碼、驗證驗證碼以及處理 Webhook 回調。

只需一條命令即可安裝,隨後就可以直接請求您的 Agent 了:

# 適用於發送 OTP 的 Skill npx skills add https://github.com/DevEngageLab/engagelab-skills/tree/main/engagelab-otp/skills/engagelab-otp-send # 適用於驗證 OTP 的 Skill npx skills add https://github.com/DevEngageLab/engagelab-skills/tree/main/engagelab-otp/skills/engagelab-otp-verify # 適用於設定和處理 webhooks/回調的 Skill npx skills add https://github.com/DevEngageLab/engagelab-skills/tree/main/engagelab-otp/skills/engagelab-otp-webhook
              
              # 適用於發送 OTP 的 Skill
npx skills add https://github.com/DevEngageLab/engagelab-skills/tree/main/engagelab-otp/skills/engagelab-otp-send

# 適用於驗證 OTP 的 Skill
npx skills add https://github.com/DevEngageLab/engagelab-skills/tree/main/engagelab-otp/skills/engagelab-otp-verify

# 適用於設定和處理 webhooks/回調的 Skill
npx skills add https://github.com/DevEngageLab/engagelab-skills/tree/main/engagelab-otp/skills/engagelab-otp-webhook

            
此代碼塊在浮窗中顯示

查看有關如何將 EngageLab OTP skills 與 AI Agent 搭配使用的更多詳細資訊:→ Agent Skills

給 Agent 看的文件 — 它可以讀取什麼格式?

您可以讓您的 Agent 查閱完整的 API Reference。每個頁面都包含了一個 API Endpoint 節點,並提供了完整的請求參數回應格式以及錯誤碼 — 這些是 Agent 在不依賴額外上下文的情況下呼叫 EngageLab OTP API 所需的全部資訊:

快速開始 — 發送和驗證您的第一個 OTP

將下面的程式碼範例複製到 Cursor 或 Claude Code 中,即可自動設定 OTP 整合:

Node.js

const { OTPClient } = require('engagelab-otp'); const otp = new OTPClient( process.env.ENGAGELAB_DEV_KEY, process.env.ENGAGELAB_DEV_SECRET ); // 平台生成 OTP — 最簡單的方法 const { message_id } = await otp.send('+6591234567', 'your-template-id', {}, 'en'); const { verified } = await otp.verify(message_id, userTypedCode);
              
              const { OTPClient } = require('engagelab-otp');

const otp = new OTPClient(
  process.env.ENGAGELAB_DEV_KEY,
  process.env.ENGAGELAB_DEV_SECRET
);

// 平台生成 OTP — 最簡單的方法
const { message_id } = await otp.send('+6591234567', 'your-template-id', {}, 'en');
const { verified }   = await otp.verify(message_id, userTypedCode);

            
此代碼塊在浮窗中顯示

Python

import os from engagelab_otp import OTPClient otp = OTPClient( os.environ["ENGAGELAB_DEV_KEY"], os.environ["ENGAGELAB_DEV_SECRET"], ) # 平台生成 OTP — 最簡單的方法 result = otp.send("+6591234567", "your-template-id", {"name": "Alice"}, language="en") check = otp.verify(result["message_id"], user_typed_code) if check["verified"]: print("Success!")
              
              import os
from engagelab_otp import OTPClient

otp = OTPClient(
    os.environ["ENGAGELAB_DEV_KEY"],
    os.environ["ENGAGELAB_DEV_SECRET"],
)

# 平台生成 OTP — 最簡單的方法
result = otp.send("+6591234567", "your-template-id", {"name": "Alice"}, language="en")
check  = otp.verify(result["message_id"], user_typed_code)
if check["verified"]:
    print("Success!")

            
此代碼塊在浮窗中顯示

EngageLab 為 OTP 工作流程提供了兩個主要 Endpoint:

操作 Endpoint 用途
Send OTP POST /v1/messages 生成驗證碼並發送給用戶。
Verify OTP POST /v1/verifications 驗證用戶提交的驗證碼。

您的 Agent 將遵循的步驟

  1. 檢測專案語言(透過讀取如 package.jsonrequirements.txt 等設定檔)
  2. 安裝 SDK — 執行 npm install engagelab-otppip install engagelab-otp
  3. 實現身份驗證 — 使用 HTTP Basic Auth 進行鑑權,格式為 base64(dev_key:dev_secret)
  4. 實現 Webhooks — 在生產環境中,設定回調 Endpoint來追蹤下發狀態

如果您想要獲取完整的錯誤碼,請參考各個 Endpoint 頁面的 API Reference (例如 發送 OTP 錯誤碼)。

還未使用過 EngageLab OTP?在運行上述程式碼之前,請按照控制台設定指南進行操作,註冊帳號、建立範本並獲取 API Key。

官方 SDK — Node.js & Python

EngageLab 是一家全球性的 OTP API 供應商,提供了官方的 Node.js 和 Python SDK,助力您更輕鬆地整合 OTP 發送、驗證以及 Webhook 回調,整個過程零額外依賴。

查看 Node.js 和 Python SDK 的安裝說明及範例:→ SDKs

常見問題 (FAQs)

AI Agent 如何在沒有人工互動的情況下發送 OTP?

EngageLab OTP API 支援完全可程式化呼叫,您的 Agent 只需呼叫 /v1/messages 來發送驗證碼,透過 /v1/verifications 即可完成驗證。 無需 UI 介面,無需任何手動操作。

如果 OTP 過期了,Agent 重試時會怎樣?

當 Agent 使用相同的接收方地址再次呼叫發送 API 時,系統會生成一個新的驗證碼,並返回一個新的 message_id。早先過期的驗證碼將被自動失效。 → 發送 OTP 錯誤碼 · 驗證 OTP 錯誤碼

我怎樣才能即時追蹤 OTP 的送達和驗證狀態?

EngageLab OTP 支援 Webhook 回調 — 只需在控制台中設定一個回調 URL,系統便會在發生關鍵事件(如:訊息已送達、OTP 已驗證、或餘額不足告警)時,將事件資料推送到您的 Endpoint 上。整個過程無需輪詢。 → 點擊查看回調設定

如何使用 Cursor 或 Windsurf 發送 OTP?

EngageLab OTP Agent Skills 使 Cursor、Windsurf 和 Claude Code 具備直接發送和驗證 OTP 所需的上下文資訊,這些操作完全可以在您的編輯器中進行。只需一條指令即可安裝 Skill:

npx skills add https://github.com/DevEngageLab/engagelab-skills/tree/main/engagelab-otp/skills/engagelab-otp-send
              
              npx skills add https://github.com/DevEngageLab/engagelab-skills/tree/main/engagelab-otp/skills/engagelab-otp-send

            
此代碼塊在浮窗中顯示

安裝完成後,您的 Agent 就可以呼叫 EngageLab OTP API (POST /v1/messages),透過 SMS、WhatsApp、Email 或 Voice 發送一次性密碼 — 並且可以使用 POST /v1/verifications 來對其進行驗證。這裡無需手動設定 API。

Icon Solid Transparent White Qiyu
聯繫銷售