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_key 和 dev_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
查看有关如何将 EngageLab OTP skills 与 AI Agent 搭配使用的更多详细信息：→ Agent Skills
给 Agent 看的文档 — 它可以读取什么格式？
您可以让您的 Agent 查阅完整的 API Reference。每个页面都包含了一个 API 接口节点，并提供了完整的请求参数、响应格式以及错误码 — 这些是 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);
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!")
EngageLab 为 OTP 工作流提供了两个主要接口终端：
| 操作 | Endpoint | 用途 |
|---|---|---|
| 发送 OTP | POST /v1/messages |
生成验证码并发送给用户。 |
| 验证 OTP | POST /v1/verifications |
验证用户提交的验证码。 |
您的 Agent 将遵循的步骤
- 检测项目语言（通过读取如
package.json、requirements.txt等配置文件） - 安装 SDK — 执行
npm install engagelab-otp或pip install engagelab-otp - 实现身份验证 — 使用 HTTP Basic Auth 进行鉴权，格式为
base64(dev_key:dev_secret) - 实现 Webhooks — 在生产环境中，设置回调接口来追踪下发状态
如果您想要获取完整的错误码，请参考各个接口页面的 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
安装完成后，您的 Agent 就可以调用 EngageLab OTP API (POST /v1/messages)，通过 SMS、WhatsApp、Email 或 Voice 发送一次性密码 — 并且可以使用 POST /v1/verifications 来对其进行验证。这里无需手动配置 API。
