返回顶部
e

engagelab-smsEngageLab短信

>

作者: admin | 来源: ClawHub
源自
ClawHub
版本
V 1.0.1
安全检测
已通过
249
下载量
免费
免费
0
收藏
概述
安装方式
版本历史

engagelab-sms

EngageLab短信API技能

本技能使您能够与EngageLab短信REST API进行交互。涵盖三个领域:

  1. 1. 发送短信 — 向一个或多个收件人发送通知或营销短信
  2. 模板管理 — 创建、读取、更新和删除短信模板
  3. 签名(发送者ID)管理 — 创建、读取、更新和删除发送者ID签名

资源

scripts/

  • - smsclient.py — Python客户端类(EngageLabSMS),封装所有API端点:sendsms()(即时和定时发送)、模板CRUD(listtemplates()、gettemplate()、createtemplate()、updatetemplate()、deletetemplate())和签名CRUD(listsignatures()、getsignature()、createsignature()、updatesignature()、deletesignature())。处理认证、请求构建和类型化错误处理。可作为即用型助手或导入到用户项目中。

references/

  • - template-and-signature-api.md — 所有模板和签名端点的完整请求/响应字段规范
  • error-codes.md — 短信发送和模板/签名操作的完整错误代码表

认证

所有EngageLab短信API调用使用HTTP基本认证

  • - 基础URL:https://smsapi.engagelab.com
  • 请求头:Authorization: Basic key:devsecret)>
  • 内容类型:application/json

用户必须提供其devkey和devsecret(也称为apikey和apisecret)。将其编码为base64(devkey:devsecret)并设置Authorization请求头。

示例(使用curl):

bash
curl -X POST https://smsapi.engagelab.com/v1/messages \
-H Content-Type: application/json \
-H Authorization: Basic $(echo -n YOURDEVKEY:YOURDEVSECRET | base64) \
-d { ... }

如果用户未提供凭据,请在生成API调用前询问其devkey和devsecret。

快速参考 — 所有端点

操作方法路径
发送短信POST/v1/messages
列出模板
GET | /v1/template-configs | | 获取模板 | GET | /v1/template-configs/:templateId | | 创建模板 | POST | /v1/template-configs | | 更新模板 | PUT | /v1/template-configs/:templateId | | 删除模板 | DELETE | /v1/template-configs/:templateId | | 列出签名 | GET | /v1/sign-configs | | 获取签名 | GET | /v1/sign-configs/:signId | | 创建签名 | POST | /v1/sign-configs | | 更新签名 | PUT | /v1/sign-configs/:signId | | 删除签名 | DELETE | /v1/sign-configs/:signId |

发送短信

端点:POST /v1/messages

请求体

json
{
to: [+6591234567],
template: {
id: TEMPLATE_ID,
params: {
var_name: value
}
},
plan_name: 可选计划名称,
schedule_time: 1700000000,
custom_args: {}
}

参数

字段类型必填描述
tostring[]目标电话号码(包含国家代码)
template.id
string | 是 | 已审批短信模板的ID | | template.params | object | 是 | 与模板变量匹配的键值对(例如,{{name}} → {name: Bob}) | | plan_name | string | 否 | 计划名称,默认为- | | schedule_time | integer | 否 | 定时发送的Unix时间戳;省略则立即发送 | | custom_args | object | 否 | 用于跟踪的自定义参数 |

模板变量

如果模板包含{{var}}占位符,通过params填充。例如,对于模板内容Hi {{name}}, your code is {{code}},传递:

json
params: { name: Alice, code: 123456 }

未填充的变量将按原样发送为{{var}}。

响应

成功(单个目标)

json
{
plan_id: 1972488990548348928,
total_count: 1,
accepted_count: 1,
message_id: 1972488990804201472
}

成功(定时发送)

json
{
plan_id: 1972492618659033088,
total_count: 1,
accepted_count: 1,
scheduleinfo: { taskid: 1972492621368553472 }
}

错误:包含code(非零)和message字段以及plan_id。

有关完整错误代码表,请阅读references/error-codes.md。

模板管理

模板定义短信内容。每个模板必须通过审核才能用于发送。

有关完整的请求/响应详情和字段描述,请阅读references/template-and-signature-api.md。

关键规则

  • - 模板内容不能包含:【、】、、、测试、test、[、]
  • 创建或更新后,模板进入待审核状态(status=1),在已批准(status=2)之前不能使用
  • 待审核的模板不能更新
  • 与待处理/运行中的短信计划关联的模板不能更新或删除
  • 模板类型:utility(通知)、marketing(营销)

CRUD摘要

创建 — POST /v1/template-configs

json
{
template_name: 订单通知,
template_type: utility,
templatecontent: 您的订单{orderno}已发货,预计{delivery_time}到达。,
country_codes: CN,US,
add_signature: true,
signid: SIGNATUREID,
sign_position: 2
}

列出所有 — GET /v1/template-configs(返回数组)

获取单个 — GET /v1/template-configs/:templateId

更新 — PUT /v1/template-configs/:templateId(与创建相同的请求体,所有字段必填)

删除 — DELETE /v1/template-configs/:templateId

签名(发送者ID)管理

签名标识发送者并附加到模板。它们也经过审核流程。

有关完整的请求/响应详情和字段描述,请阅读references/template-and-signature-api.md。

关键规则

  • - 签名名称:2–60个字符,不能包含【、】、[、]
  • 同一业务内名称必须唯一
  • 创建或更新后,签名进入待审核状态(status=1)
  • 待审核的签名不能更新
  • 与待处理/运行中的计划关联的签名不能更新或删除

CRUD摘要

创建 — POST /v1/sign-configs

json
{ sign_name: 我的公司 }

列出所有 — GET /v1/sign-configs(返回数组)

获取单个 — GET /v1/sign-configs/:signId

更新 — PUT /v1/sign-configs/:signId(与创建相同的请求体)

删除 — DELETE /v1/sign-configs/:signId

生成代码

当用户要求发送短信或管理模板/签名时,生成可工作的代码。除非用户指定语言,否则默认使用curl。支持的格式:

  • - curl — 带有正确认证请求头的Shell命令
  • Python — 使用requests库
  • Node.js — 使用fetch或axios
  • Java — 使用HttpClient
  • Go — 使用net/http

始终包含认证请求头和适当的错误处理。如果用户未提供凭据,使用YOURDEVKEY和YOURDEVSECRET等占位符值。

##

标签

skill ai

通过对话安装

该技能支持在以下平台通过对话安装:

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 engagelab-sms-1776158470 技能

方式二:设置 SkillHub 为优先技能安装源

设置 SkillHub 为我的优先技能安装源,然后帮我安装 engagelab-sms-1776158470 技能

通过命令行安装

skillhub install engagelab-sms-1776158470

下载

⬇ 下载 engagelab-sms v1.0.1(免费)

文件大小: 9.19 KB | 发布时间: 2026-4-15 13:08

v1.0.1 最新 2026-4-15 13:08
- No functional changes in this release.
- Documentation updated: `to` parameter example in SMS requests changed from a Chinese phone number to a Singaporean phone number in the usage section.

Archiver·手机版·闲社网·闲社论坛·羊毛社区· 多链控股集团有限公司 · 苏ICP备2025199260号-1

Powered by Discuz! X5.0   © 2024-2025 闲社网·线报更新论坛·羊毛分享社区·http://xianshe.com

p2p_official_large
返回顶部