------------------------------------------------------------
✅ 设置API
克隆仓库并运行此命令
npm install(安装npm包)
在文件夹中添加 .env 文件
以“node index.js”命令运行
------------------------------------------------------------
✅ 健康检查
检查封装服务是否正常运行
------------------------------------------------------------
内容类型:应用/JSON
示例回复:
{
"状态": "正常",
"service": "Success.ai 封装器",,
}
------------------------------------------------------------
🔹 获取活动(快捷端点)
直接获取活动列表(映射到 /v1/campaign/list)
------------------------------------------------------------
获取 http://localhost:3000/campaigns?limit=10(即:向 http://localhost:3000/campaigns 发送 GET 请求,查询参数为 limit=10)
内容类型:应用/JSON
示例回复:
{
}
------------------------------------------------------------
🔹 添加联系人(快捷方式终端)
向活动添加一个或多个联系人
------------------------------------------------------------
POST 请求发送至 http://localhost:3000/contact/add
内容类型:应用/JSON
{
"联系人": [
]
}
示例回复:
{
"插入": 2
}
------------------------------------------------------------
🔹 通用代理(主要终端节点)
使用此方法调用任何Success.ai API接口
------------------------------------------------------------
POST 请求发送至 http://localhost:3000/proxy
内容类型:application/json
{
"方法": "GET",
}
示例回复:
------------------------------------------------------------
🔹 获取活动状态(通过/proxy)
使用特定API的通用代理的示例
------------------------------------------------------------
POST http://localhost:3000/proxy(中文可译为:“向 http://localhost:3000/proxy 发送 POST 请求”,但通常在技术语境中,我们直接保留原句,因为“POST”是HTTP方法,直接使用即可理解。)
内容类型:application/json
{
"方法": "GET",
}
示例回复:
{
"状态": "运行中",,
"进度": 42
}
------------------------------------------------------------
🔹 创建新活动(通过/proxy)
示例:通过代理执行POST操作
------------------------------------------------------------
POST 请求发送至 http://localhost:3000/proxy
内容类型:application/json
{
"方法": "POST",
"body": {
“名称”:“新人工智能推广活动”,
主题:“欢迎来到SuccessAI!”,
"templateId": "模板_01"
}
}
示例回复:
{
}
------------------------------------------------------------
🔹 删除活动(通过/proxy)
示例展示DELETE方法的使用
------------------------------------------------------------
POST 请求发送至 http://localhost:3000/proxy
内容类型:应用/JSON
{
}
示例回复:
{"success": 真, "deleted": 真}
------------------------------------------------------------
🧪 测试无效路由(用于调试)
展示了错误如何以JSON格式返回
------------------------------------------------------------
POST 请求发送到 http://localhost:3000/proxy
内容类型:应用/JSON
{
"方法": "GET",,
"path": "/v1/无效/路由"
}
