BillionMail API 发件功能使用指南
功能概述
BillionMail API发件功能提供了一套完整的邮件发送解决方案，支持以下核心功能：
✉️ 模板化邮件发送
👤 自定义发件人
📊 完整的数据追踪（打开率/点击率/退率）
🔄 退订管理
📈 详细的发送统计
API密钥管理
创建API密钥
发件API --> 新建API
点击 “新建API”，填写相关信息（API名称、邮件模板、发件人、主题、IP白名单等），系统会自动生成唯一的 API Key。
- 支持为每个 API 设置独立的 IP 白名单，提升安全性
发送邮件API
发送单封邮件
请求信息：
接口：
/api/batch_mail/api/send方法：
POST认证：需要
请求头：
X-API-Key: YOUR_API_KEY
Content-Type: application/json请求体：
{
"recipient": "[email protected]",
"addresser": "[email protected]"
}请求参数说明：
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| recipient | string | 是 | 收件人邮箱地址 |
| addresser | string | 否 | 自定义发件人邮箱地址 |
说明: 如果不传递
addresser参数，将使用默认的发件人邮箱。
响应示例：
{
"success": true,
"code": 0,
"msg": "Email sent successfully",
"data": null
}使用示例
CURL示例
# 发送邮件
curl -k -X POST 'https://your-domain.com/api/batch_mail/api/send' \
-H 'X-API-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"recipient": "[email protected]"
}'Python示例
import requests
def send_email(api_key, recipient):
url = 'https://your-domain.com/api/batch_mail/api/send'
headers = {
'X-API-Key': api_key
}
data = {
'recipient': recipient
}
response = requests.post(url, headers=headers, json=data)
return response.json()错误码说明
| 错误码 | 说明 | 解决方案 |
|---|---|---|
| 1001 | API密钥无效 | 检查API密钥是否正确 |
| 1002 | IP不允许 | 检查是否设置了ip白名单 |
| 1003 | 收件人无效 | 检查邮箱地址格式 |
| 1004 | 模板不存在 | 检查模板ID |
| 1005 | 发送失败 | 查看详细错误日志 |
功能特性说明
IP 白名单功能
可为每个 API 单独配置 IP 白名单，仅允许指定 IP 调用 API。
若未设置白名单，则所有 IP 均可访问。
白名单支持在 API 创建和更新时配置，支持后续随时调整。
非白名单 IP 调用时将返回错误码 1002。
邮件追踪功能
打开追踪
自动记录邮件打开次数
统计独立打开用户数
提供打开时间分布数据
链接追踪
追踪邮件中的链接点击
记录点击用户和时间
分析链接点击热度
数据统计
实时更新统计数据
提供多维度分析
退订管理(可选)
退订链接
自动在邮件底部添加退订链接
支持一键退订功能
自动更新退订状态
退订名单管理
- 维护全局退订列表
发送统计
提供以下维度的统计数据：
发送总数
送达率
打开率
点击率
退信率
退订率
最佳实践
安全建议
API密钥管理
妥善保管API密钥
定期更换API密钥
避免密钥泄露
访问控制
使用HTTPS进行API调用
设置IP白名单
监控异常访问
发送优化
发送策略
合理控制发送频率
避免密集发送
关注发送统计
地址管理
定期清理无效地址
及时处理退信
维护黑名单
内容优化
模板管理
使用变量实现个性化
保持模板简洁
定期更新内容
效果优化
进行A/B测试
分析统计数据
优化发送时间
常见问题
1. 发送问题
Q: 如何处理发送失败的邮件？
A: 系统会自动记录发送失败的邮件，可以通过面板内api管理列表查看失败原因
2. 统计问题
Q: 如何提高送达率？
A: 保持良好的发送记录，避免发送垃圾邮件，定期清理无效地址。
3. 功能问题
Q: 如何查看发送统计？
A: 可以通过面板内API列表
4. 技术问题
Q: 是否支持批量发送？
A: 目前API仅支持单封邮件发送，批量发送请使用任务功能。
5. 其他问题
Q: 如何处理退订请求？
A: 系统自动处理退订请求，并维护退订列表。