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 连接实现高效、可靠的消息下发和状态回报。