EngageLab SMS REST API

短信 API 全功能控制台

基于官方 API 参考整理:调用验证、发送短信、模板配置、签名配置、回调事件、余额查询和 SMPP 参考。Dev Secret 只在 PHP 后端读取,前端通过本地代理请求 EngageLab。

当前 Dev Key d8fq************sgi0 可用环境变量 ENGAGELAB_DEV_KEY / ENGAGELAB_DEV_SECRET 覆盖

调用验证

所有 REST API 请求都使用 HTTP Basic Auth,后端生成 Authorization,避免密钥暴露到浏览器。

Basic Auth
HeaderAuthorization: Basic base64(dev_key:dev_secret)
域名https://smsapi.engagelab.com
安全生产环境建议只使用环境变量配置密钥,并限制服务器出口 IP。

发送短信

POST /v1/messages,支持单发、群发、计划名称、定时发送和自定义业务参数。

POST /v1/messages
发送正文必须来自审核通过的模板。模板需要什么变量,就必须在 params JSON 里传同名字段;例如错误提示 template variable 'code' is required 时,应填写 { "code": "039487" }。Sender ID 需要在模板配置中用签名 ID 绑定。

模板配置

覆盖获取列表、获取详情、创建、更新、删除模板配置。状态:1 待审核,2 通过,3 拒绝。

/v1/template-configs
Sender ID 对应这里的“签名 ID / sign_id”。先在“签名配置”创建 Sender ID,再在模板配置中填写签名 ID 绑定到模板;发送短信时只需要传模板 ID 和模板变量。

签名配置

覆盖获取列表、获取详情、创建、更新、删除签名配置。签名又称 Sender ID。

/v1/sign-configs

查询余额

GET /v1/balance,返回普通余额、赠送余额和总余额,建议优先使用 *10000 整数字段避免浮点精度问题。

GET /v1/balance

回调事件参考

把控制台回调地址配置为本页生成的接收地址,即可记录 EngageLab 推送事件。

Webhook
地址https://vpn.php.gd/api/callback.php
入口api/callback.php 会把原始 body、解析后的 JSON 和请求头保存到 MySQL 表 engagelab_callback_events。
数据库状态未检查
保存表engagelab_callback_events
记录数量--
点击“读取最近回调”查看数据库中保存的推送事件。
回调详情未选择
点击表格中的“查看”按钮显示完整回调内容。

SMPP

SMPP 是长连接协议,不适合直接由浏览器调用。本页面保留连接参数记录区,实际接入建议在后端服务或队列进程中实现。

TCP
REST API 已覆盖短信发送、模板、签名和余额;SMPP 适合高吞吐、长连接、状态报告持续接收的服务端场景。