article
README
🚀 智能领导力API文档
智能领导力API为开发者提供了便捷的接口,用于创建营销活动、管理邮件账户和线索等操作,助力企业高效开展营销工作。
🚀 快速开始
要使用智能领导力API,请按照以下步骤操作:
- 注册开发者账号:访问官方网站并创建一个开发者账户。
- 获取访问令牌:登录后进入“我的应用”部分,创建新应用并获取API访问令牌。
- 开始使用:使用获取到的令牌开始调用API。
📚 详细文档
API基础
基本URL
所有API请求都需要发送到:
https://api.smartlead.com/v1
请求头
在每次请求中,必须包含以下头部信息:
Authorization: Bearer <访问令牌>Content-Type: application/json
响应格式
API返回的数据格式为JSON。响应状态码如下:
- 200: 成功
- 401: 未授权
- 403: 禁止访问
- 404: 资源未找到
- 500: 服务器错误
功能模块
创建活动
创建新的营销活动。
- 请求URL
POST /campaigns
- 请求参数 | 参数名 | 类型 | 是否必填 | 描述 | | ---- | ---- | ---- | ---- | | name | string | 是 | 活动名称 | | type | string | 是 | 活动类型(例如:冷邮件、电话营销) | | description | string | 否 | 活动描述 |
- 响应示例
{
"id": "654321",
"name": "夏季促销活动",
"status": "active"
}
获取所有活动
列出所有创建的活动。
- 请求URL
GET /campaigns
- 响应示例
[
{
"id": "654321",
"name": "夏季促销活动",
"status": "active"
},
...
]
邮件账户管理
添加邮件账户
将现有邮件账户添加到活动中。
- 请求URL
POST /campaigns/{id}/email-accounts
- 请求参数 | 参数名 | 类型 | 是否必填 | 描述 | | ---- | ---- | ---- | ---- | | email_account_id | string | 是 | 邮件账户ID |
更新邮件账户设置
更新活动中某个邮件账户的配置。
- 请求URL
PUT /campaigns/{id}/email-accounts/{emailAccountId}
- 请求参数 | 参数名 | 类型 | 是否必填 | 描述 | | ---- | ---- | ---- | ---- | | settings | object | 是 | 邮件账户配置 |
移除邮件账户
从活动中移除指定的邮件账户。
- 请求URL
DELETE /campaigns/{id}/email-accounts/{emailAccountId}
线索管理
添加线索到活动
将多个线索添加到活动中。
- 请求URL
POST /campaigns/{id}/leads
- 请求参数 | 参数名 | 类型 | 是否必填 | 描述 | | ---- | ---- | ---- | ---- | | lead_list | array | 是 | 线索数组 |
响应状态码
所有API调用返回的状态码如下:
- 200: 成功
- 401: 未授权
- 403: 禁止访问
- 404: 资源未找到
- 500: 服务器错误
📄 许可证
本API文档遵循MIT许可证,允许用户免费使用和修改代码,但需保留版权声明。
如需了解更多信息,请联系支持团队或查阅开发者论坛。
Scan to contact