临时邮箱 API 文档与测试中心

在同一页面阅读文档、测试接口、复制代​​码。

基础 URL:
https://v1.boomlify.com

POST /api/v1/emails/create

创建一个新的临时邮箱地址 现在支持可选的 custom_username 参数来创建具有个性化地址的邮箱。

需要认证有速率限制

文档

参数

查询
custom_username
邮箱地址的可选自定义用户名。可以包含字母、数字、点、连字符和下划线。必须是 3-30 个字符。如果省略,将生成随机用户名。
示例: john.doe
⚠️ ⚠️ 必须是 3-30 个字符。不能以特殊字符开头/结尾。必须唯一。如果已被占用,返回 409。
查询
time
过期时间
示例: permanent
⚠️ 必须是以下之一:10min, 1hour, 1day, permanent
查询
domain
邮箱地址的可选自定义域名。必须是您账户中已验证的域名(使用 custom_domains 端点进行验证)。如果未指定,将使用随机公共域名。
示例: mail.yourdomain.com
⚠️ ⚠️ 必须是已验证的自定义域名或公共域名。如果不可用,返回 400。
查询
create_as_dashboard
💎 高级功能 - 设置为 "true" 以创建存储在数据库中的仪表板样式邮箱,具有固定的 2 个月过期时间,而不是基于时间的 API 邮箱。省略或设置为 "false" 用于基于时间的邮箱(默认)。仪表板邮箱花费 15 积分。免费用户将收到 403 错误。
示例: true
⚠️ ⚠️ 必须是 "true" 或省略。仪表板邮箱需要基础套餐或更高版本。固定 2 个月过期(忽略时间参数)。

错误示例

400
INVALID_USERNAME
用户名必须至少 3 个字符
自定义用户名验证失败。必须仅包含有效字符的 3-30 个字符。
409
EMAIL_IN_USE
邮箱地址 "[email protected]" 已被使用
自定义用户名已被占用。请选择不同的用户名。
400
DOMAIN_NOT_FOUND
域名 "custom.domain" 不可用。它必须是您账户中已验证的自定义域名或公共域名。
指定的域名不存在或未验证。请先在您的账户中验证它。
400
DOMAIN_NOT_VERIFIED
自定义域名 "custom.domain" 未验证。当前状态:待处理
域名存在但尚未验证。请先完成域名验证。
429
DAILY_LIMIT_EXCEEDED
1小时邮箱的每日限制已超出
您已达到此类邮箱的每日限制

请求示例

curl -X POST "https://v1.boomlify.com/api/v1/emails/create"

代码片段

const response = await fetch("https://v1.boomlify.com/api/v1/emails/create", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
});

const data = await response.json();
API 中心
测试 API

社区聊天

100 of 1352 messages

543

👋 欢迎来到社区聊天!

您可以查看消息,但需要账户才能加入对话