Temp Mail API Documentation - Boomlify

Complete API reference for temporary email service integration

POST`/api/v1/emails/create`

Tạo địa chỉ email tạm thời mới Bây giờ hỗ trợ tham số tùy chọn custom_username để tạo email với địa chỉ được cá nhân hóa.

Parameters:

custom_username (query, optional): Tên người dùng tùy chỉnh tùy chọn cho địa chỉ email. Có thể chứa chữ cái, số, dấu chấm, dấu gạch ngang và dấu gạch dưới. Phải có từ 3 đến 30 ký tự. Nếu bỏ qua, tên người dùng ngẫu nhiên sẽ được tạo. - Example: john.doe
time (query, optional): Thời gian hết hạn - Example: permanent
domain (query, optional): Tên miền tùy chỉnh tùy chọn cho địa chỉ email. Phải là tên miền đã được xác minh trong tài khoản của bạn (sử dụng endpoint custom_domains để xác minh). Nếu không được chỉ định, một tên miền công cộng ngẫu nhiên sẽ được sử dụng. - Example: mail.yourdomain.com
create_as_dashboard (query, optional): 💎 Tính năng Premium - Đặt thành "true" để tạo email kiểu bảng điều khiển được lưu trong cơ sở dữ liệu với thời gian hết hạn cố định 2 tháng thay vì email API dựa trên thời gian. Bỏ qua hoặc đặt thành "false" cho email dựa trên thời gian (mặc định). Email bảng điều khiển tốn 15 tín dụng. Người dùng cấp miễn phí sẽ nhận lỗi 403. - Example: true

Error Responses:

INVALID_USERNAME (400): Xác thực tên người dùng tùy chỉnh thất bại. Phải có từ 3 đến 30 ký tự chỉ với các ký tự hợp lệ.
EMAIL_IN_USE (409): Tên người dùng tùy chỉnh đã được sử dụng. Chọn tên người dùng khác.
DOMAIN_NOT_FOUND (400): Tên miền được chỉ định không tồn tại hoặc chưa được xác minh. Xác minh nó trước trong tài khoản của bạn.
DOMAIN_NOT_VERIFIED (400): Tên miền tồn tại nhưng chưa được xác minh. Hoàn tất xác minh tên miền trước.
DAILY_LIMIT_EXCEEDED (429): Bạn đã đạt giới hạn hàng ngày cho loại email này

Auth Required: Yes | Rate Limited: Yes | Group: Quickstart

GET`/api/v1/emails`

Liệt kê tất cả email tạm thời đang hoạt động của bạn

Parameters:

include_expired (query, optional): Bao gồm email đã hết hạn - Example: true
permanent_only (query, optional): Chỉ hiển thị hộp thư vĩnh viễn đã lưu của bạn. Tốn 2 tín dụng mỗi yêu cầu. - Example: true
include_permanent (query, optional): Bao gồm hộp thư vĩnh viễn đã lưu của bạn cùng với những cái gần đây. Tốn 2 tín dụng mỗi yêu cầu. - Example: true
limit (query, optional): Số lượng email trả về - Example: 50

Error Responses:

INSUFFICIENT_CREDITS (402): Được trả về khi cố gắng liệt kê hộp thư vĩnh viễn đã lưu nhưng tài khoản thiếu tín dụng.

Auth Required: Yes | Rate Limited: No | Group: Emails

GET`/api/v1/emails/{id}`

Lấy chi tiết của một email cụ thể

Parameters:

id (path, required): ID email - Example: 550e8400-e29b-41d4-a716-446655440000

Error Responses:

EMAIL_NOT_FOUND (404): ID email không hợp lệ hoặc email đã hết hạn

Auth Required: Yes | Rate Limited: No | Group: Emails

GET`/api/v1/emails/{id}/messages`

Lấy tin nhắn cho một email cụ thể

Parameters:

id (path, required): ID email - Example: 550e8400-e29b-41d4-a716-446655440000
limit (query, optional): Số lượng tin nhắn trả về - Example: 50
offset (query, optional): Số lượng tin nhắn bỏ qua - Example: 0

Error Responses:

EMAIL_NOT_FOUND (404): ID email không hợp lệ hoặc email đã hết hạn
INVALID_LIMIT (400): Tham số giới hạn nằm ngoài phạm vi hợp lệ

Auth Required: Yes | Rate Limited: No | Group: Emails

DELETE`/api/v1/emails/{id}`

Xóa email theo ID. Hỗ trợ cả email API dựa trên thời gian (trong bộ nhớ, bị xóa ngay lập tức) và email bảng điều khiển (lưu trữ trong cơ sở dữ liệu, bị xóa ngay lập tức). Trả về 404 nếu email không tìm thấy hoặc đã bị xóa.

Parameters:

id (path, required): ID email (định dạng UUID). Có thể là ID email API dựa trên thời gian hoặc ID email bảng điều khiển được tạo với create_as_dashboard=true - Example: 550e8400-e29b-41d4-a716-446655440000

Error Responses:

EMAIL_NOT_FOUND (404): Email không tồn tại hoặc đã bị xóa

Auth Required: Yes | Rate Limited: No | Group: Emails

GET`/api/v1/emails`

💎 Tính năng Premium - Liệt kê tất cả email, bao gồm email được tạo trong bảng điều khiển. Endpoint này hợp nhất email được tạo qua API với email bảng điều khiển của bạn trong một phản hồi duy nhất. Tốn 2 tín dụng mỗi yêu cầu. Yêu cầu gói Basic trở lên.

Parameters:

include_dashboard (query, required): Phải được đặt thành "true" để truy cập email bảng điều khiển. Điều này kích hoạt tính năng premium và tính phí 2 tín dụng. - Example: true
include_expired (query, optional): Bao gồm email đã hết hạn trong phản hồi (email API và email bảng điều khiển) - Example: false
limit (query, optional): Số lượng email tối đa để trả về (tối đa: 100) - Example: 50

Error Responses:

TIER_RESTRICTED (403): Đây là tính năng premium. Người dùng cấp miễn phí không thể truy cập email bảng điều khiển qua API.
INSUFFICIENT_CREDITS (402): Thao tác này tốn 2 tín dụng. Vui lòng thêm tín dụng vào tài khoản của bạn.

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

GET`/api/v1/emails/{id}`

💎 Tính năng Premium - Lấy thông tin chi tiết về một email bảng điều khiển cụ thể. Nếu email không được tìm thấy trong kho lưu trữ API, nó sẽ tìm kiếm trong email bảng điều khiển của bạn. Tốn 1 tín dụng mỗi yêu cầu. Yêu cầu gói Basic trở lên.

Parameters:

id (path, required): ID email bảng điều khiển (định dạng UUID) - Sao chép điều này từ bảng điều khiển của bạn hoặc từ endpoint list-dashboard-emails - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Phải là "true" để tìm kiếm email bảng điều khiển. Tính phí 1 tín dụng. - Example: true

Error Responses:

TIER_RESTRICTED (403): Truy cập email bảng điều khiển yêu cầu gói trả phí
INSUFFICIENT_CREDITS (402): Thao tác này tốn 1 tín dụng
EMAIL_NOT_FOUND (404): Email yêu cầu không tìm thấy hoặc đã hết hạn

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

GET`/api/v1/emails/{id}/messages`

💎 Tính năng Premium - Lấy tất cả tin nhắn đã nhận cho một email bảng điều khiển với hỗ trợ phân trang. Sử dụng bộ nhớ đệm để thời gian phản hồi nhanh. Tốn 1 tín dụng mỗi yêu cầu. Yêu cầu gói Basic trở lên.

Parameters:

id (path, required): ID email bảng điều khiển - UUID của email mà bạn muốn lấy tin nhắn - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Phải là "true" để truy cập tin nhắn email bảng điều khiển. Tính phí 1 tín dụng. - Example: true
limit (query, optional): Số lượng tin nhắn tối đa để trả về mỗi trang (tối đa: 100) - Example: 20
offset (query, optional): Số lượng tin nhắn bỏ qua cho phân trang (ví dụ: offset=20 với limit=20 lấy trang 2) - Example: 0

Error Responses:

TIER_RESTRICTED (403): Truy cập email bảng điều khiển yêu cầu gói trả phí
INSUFFICIENT_CREDITS (402): Thao tác này tốn 1 tín dụng
EMAIL_NOT_FOUND (404): Email yêu cầu không tìm thấy hoặc đã hết hạn

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

GET`/api/v1/emails/{id}/telegram-forwarding`

Premium Feature - Get Telegram forwarding status for a specific owned mailbox. Supports dashboard mailboxes and permanent API mailboxes. Ownership is checked through the existing cached mailbox lookup paths, and forwarding state is returned from the forwarding cache. Costs 2 credits per request. Requires Basic plan or higher.

Parameters:

id (path, required): Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding status you want to inspect - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Must be set to "true" to access Telegram forwarding mailbox status. Charges 2 credits. - Example: true

Error Responses:

TIER_RESTRICTED (403): This is a premium feature. Free tier users cannot access dashboard email forwarding via API.
INSUFFICIENT_CREDITS (402): This operation costs 2 credits. Please add more credits to your account.
EMAIL_NOT_FOUND (404): The requested mailbox was not found, is unsupported, or has expired

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

POST`/api/v1/emails/{id}/telegram-forwarding`

Premium Feature - Enable or disable Telegram forwarding for an owned mailbox. Supports dashboard mailboxes and permanent API mailboxes, while reusing the existing forwarding cache and write-through persistence path. Costs 2 credits per request. Requires Basic plan or higher and an active Telegram binding.

Parameters:

id (path, required): Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding you want to update - Example: 550e8400-e29b-41d4-a716-446655440000
include_dashboard (query, required): Must be set to "true" to update Telegram mailbox forwarding. Charges 2 credits. - Example: true
is_enabled (body, required): Boolean body field. Set true to enable forwarding or false to disable forwarding. - Example: true

Error Responses:

TIER_RESTRICTED (403): This is a premium feature. Free tier users cannot update dashboard email forwarding via API.
INSUFFICIENT_CREDITS (402): This operation costs 2 credits. Please add more credits to your account.
NO_TELEGRAM_BINDING (400): Forwarding cannot be enabled until the account has an active verified Telegram binding.
FORWARDING_LIMIT_EXCEEDED (403): The user has reached the plan limit for active Telegram forwardings.
EMAIL_NOT_FOUND (404): The requested mailbox was not found, is unsupported, or has expired

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

POST`/api/v1/emails/telegram-forwarding/bulk-enable`

Premium Feature - Bulk enable Telegram forwarding for multiple owned mailboxes in one API request. Supports dashboard mailboxes and permanent API mailboxes, reuses the existing per-email forwarding enable flow, and respects the active-forwarding limit. Costs 2 credits per request. Requires Basic plan or higher and an active Telegram binding.

Parameters:

include_dashboard (query, required): Must be set to "true" to bulk enable Telegram mailbox forwarding. Charges 2 credits. - Example: true
email_ids (body, required): Body field containing a non-empty array of owned mailbox IDs. In the test form, you can enter a single mailbox ID or a JSON array. - Example: ["550e8400-e29b-41d4-a716-446655440000"]

Error Responses:

TIER_RESTRICTED (403): This is a premium feature. Free tier users cannot bulk enable dashboard email forwarding via API.
INSUFFICIENT_CREDITS (402): This operation costs 2 credits total per bulk request.
NO_TELEGRAM_BINDING (400): Forwarding cannot be enabled until the account has an active verified Telegram binding.
FORWARDING_LIMIT_EXCEEDED (403): The user has reached the plan limit for active Telegram forwardings.
EMAIL_NOT_FOUND (404): No matching forwardable mailboxes were found.

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

POST`/api/v1/emails/create`

💎 Tính năng Premium - Tạo email mới với tên người dùng tùy chỉnh tùy chọn. Email bảng điều khiển (create_as_dashboard=true) được lưu trong cơ sở dữ liệu với thời gian hết hạn cố định 2 tháng và tốn 15 tín dụng. Email API dựa trên thời gian hỗ trợ tùy chọn thời gian tùy chỉnh (10min, 1hour, 1day, permanent). Cả hai đều hỗ trợ custom_username. Yêu cầu gói Basic trở lên.

Parameters:

create_as_dashboard (query, optional): Đặt thành "true" để tạo email kiểu bảng điều khiển được lưu trong cơ sở dữ liệu với thời gian hết hạn cố định 2 tháng. Nếu bỏ qua, tạo email API dựa trên thời gian trong bộ nhớ. Cả hai đều hỗ trợ custom_username. - Example: true
custom_username (query, optional): Tên người dùng tùy chỉnh tùy chọn cho địa chỉ email. Có thể chứa chữ cái, số, dấu chấm, dấu gạch ngang và dấu gạch dưới. Phải có từ 3 đến 30 ký tự. Nếu bỏ qua, tên người dùng ngẫu nhiên sẽ được tạo. - Example: john.doe
domain (query, optional): Tên miền tùy chỉnh tùy chọn cho địa chỉ email. Nếu không được chỉ định, một tên miền công cộng ngẫu nhiên sẽ được sử dụng. - Example: mail.yourdomain.com

Error Responses:

TIER_RESTRICTED (403): Tạo email bảng điều khiển yêu cầu gói trả phí
INSUFFICIENT_CREDITS (402): Thao tác này tốn 15 tín dụng
INVALID_USERNAME (400): Xác thực tên người dùng tùy chỉnh thất bại. Phải có từ 3 đến 30 ký tự chỉ với các ký tự hợp lệ.
EMAIL_IN_USE (409): Tên người dùng tùy chỉnh đã được sử dụng. Chọn tên người dùng khác.
INVALID_TIME_PARAMETER (400): Thời gian phải là một trong: 10min, 1hour, 1day, permanent

Auth Required: Yes | Rate Limited: Yes | Group: Dashboard

GET`/api/v1/account/usage`

Lấy thống kê sử dụng API của bạn

Error Responses:

UNAUTHORIZED (401): API key là bắt buộc và phải hợp lệ

Auth Required: Yes | Rate Limited: No | Group: Account

GET`/api/v1/account/info`

Lấy thông tin tài khoản của bạn

Error Responses:

UNAUTHORIZED (401): API key là bắt buộc và phải hợp lệ

Auth Required: Yes | Rate Limited: No | Group: Account

GET`/api/v1/account/credits`

Lấy thông tin chi tiết về số dư tín dụng và sử dụng

Error Responses:

UNAUTHORIZED (401): API key là bắt buộc và phải hợp lệ

Auth Required: Yes | Rate Limited: No | Group: Account

Trung Tâm Tài Liệu & Kiểm Thử API Temp Mail

Đọc tài liệu, thử endpoint và sao chép mã — tất cả trên một trang.

URL gốc:

https://v1.boomlify.com

Bắt đầu nhanh

Email

💎 Dashboard API (Premium)

Tài khoản

POST /api/v1/emails/create

Tạo địa chỉ email tạm thời mới Bây giờ hỗ trợ tham số tùy chọn custom_username để tạo email với địa chỉ được cá nhân hóa.

Yêu cầu xác thựcGiới hạn tần suất

Tài liệu

Tham số

truy vấn

custom_username

Tên người dùng tùy chỉnh tùy chọn cho địa chỉ email. Có thể chứa chữ cái, số, dấu chấm, dấu gạch ngang và dấu gạch dưới. Phải có từ 3 đến 30 ký tự. Nếu bỏ qua, tên người dùng ngẫu nhiên sẽ được tạo.

Ví dụ: john.doe

⚠️ ⚠️ Phải có từ 3 đến 30 ký tự. Không thể bắt đầu/kết thúc bằng ký tự đặc biệt. Phải là duy nhất. Trả về 409 nếu đã được sử dụng.

truy vấn

time

Thời gian hết hạn

Ví dụ: permanent

⚠️ Phải là một trong: 10min, 1hour, 1day, permanent

truy vấn

domain

Tên miền tùy chỉnh tùy chọn cho địa chỉ email. Phải là tên miền đã được xác minh trong tài khoản của bạn (sử dụng endpoint custom_domains để xác minh). Nếu không được chỉ định, một tên miền công cộng ngẫu nhiên sẽ được sử dụng.

Ví dụ: mail.yourdomain.com

⚠️ ⚠️ Phải là tên miền tùy chỉnh đã được xác minh hoặc tên miền công cộng. Trả về 400 nếu không khả dụng.

truy vấn

create_as_dashboard

💎 Tính năng Premium - Đặt thành "true" để tạo email kiểu bảng điều khiển được lưu trong cơ sở dữ liệu với thời gian hết hạn cố định 2 tháng thay vì email API dựa trên thời gian. Bỏ qua hoặc đặt thành "false" cho email dựa trên thời gian (mặc định). Email bảng điều khiển tốn 15 tín dụng. Người dùng cấp miễn phí sẽ nhận lỗi 403.

Ví dụ: true

⚠️ ⚠️ Phải là "true" hoặc bỏ qua. Email bảng điều khiển yêu cầu gói Basic trở lên. Thời gian hết hạn cố định 2 tháng (tham số thời gian bị bỏ qua).

Ví dụ lỗi

400

INVALID_USERNAME

Tên người dùng phải có ít nhất 3 ký tự

Xác thực tên người dùng tùy chỉnh thất bại. Phải có từ 3 đến 30 ký tự chỉ với các ký tự hợp lệ.

409

EMAIL_IN_USE

Địa chỉ email "[email protected]" đã được sử dụng

Tên người dùng tùy chỉnh đã được sử dụng. Chọn tên người dùng khác.

400

DOMAIN_NOT_FOUND

Tên miền "custom.domain" không khả dụng. Nó phải là tên miền tùy chỉnh đã được xác minh trong tài khoản của bạn hoặc tên miền công cộng.

Tên miền được chỉ định không tồn tại hoặc chưa được xác minh. Xác minh nó trước trong tài khoản của bạn.

400

DOMAIN_NOT_VERIFIED

Tên miền tùy chỉnh "custom.domain" chưa được xác minh. Trạng thái hiện tại: đang chờ

Tên miền tồn tại nhưng chưa được xác minh. Hoàn tất xác minh tên miền trước.

429

DAILY_LIMIT_EXCEEDED

Đã vượt giới hạn hàng ngày cho email 1 giờ

Bạn đã đạt giới hạn hàng ngày cho loại email này

Yêu cầu ví dụ

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

Đoạn mã

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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Tài liệu

Tham số

truy vấn

include_expired

Bao gồm email đã hết hạn

Ví dụ: true

⚠️ Phải là "true" hoặc "false"

truy vấn

permanent_only

Chỉ hiển thị hộp thư vĩnh viễn đã lưu của bạn. Tốn 2 tín dụng mỗi yêu cầu.

Ví dụ: true

⚠️ Phải là "true" hoặc "false"

truy vấn

include_permanent

Bao gồm hộp thư vĩnh viễn đã lưu của bạn cùng với những cái gần đây. Tốn 2 tín dụng mỗi yêu cầu.

Ví dụ: true

⚠️ Phải là "true" hoặc "false"

truy vấn

limit

Số lượng email trả về

Ví dụ: 50

⚠️ Tối đa 100 email

Ví dụ lỗi

402

INSUFFICIENT_CREDITS

Thêm tín dụng để liệt kê hộp thư vĩnh viễn.

Được trả về khi cố gắng liệt kê hộp thư vĩnh viễn đã lưu nhưng tài khoản thiếu tín dụng.

Yêu cầu ví dụ

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

Đoạn mã

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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Tài liệu

Tham số

đường dẫnBắt buộc

ID email

Ví dụ: 550e8400-e29b-41d4-a716-446655440000

⚠️ Phải là UUID hợp lệ

Ví dụ lỗi

404

EMAIL_NOT_FOUND

Email yêu cầu không tìm thấy hoặc đã hết hạn

ID email không hợp lệ hoặc email đã hết hạn

Yêu cầu ví dụ

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

Đoạn mã

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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Tài liệu

Tham số

đường dẫnBắt buộc

ID email

Ví dụ: 550e8400-e29b-41d4-a716-446655440000

⚠️ Phải là UUID hợp lệ

truy vấn

limit

Số lượng tin nhắn trả về

Ví dụ: 50

⚠️ Tối đa 100 tin nhắn

truy vấn

offset

Số lượng tin nhắn bỏ qua

Ví dụ: 0

⚠️ Phải là số nguyên không âm

Ví dụ lỗi

404

EMAIL_NOT_FOUND

Email yêu cầu không tìm thấy hoặc đã hết hạn

ID email không hợp lệ hoặc email đã hết hạn

400

INVALID_LIMIT

Giới hạn phải từ 1 đến 100

Tham số giới hạn nằm ngoài phạm vi hợp lệ

Yêu cầu ví dụ

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

Đoạn mã

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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Tài liệu

Tham số

đường dẫnBắt buộc

ID email (định dạng UUID). Có thể là ID email API dựa trên thời gian hoặc ID email bảng điều khiển được tạo với create_as_dashboard=true

Ví dụ: 550e8400-e29b-41d4-a716-446655440000

⚠️ Phải là UUID hợp lệ

Ví dụ lỗi

404

EMAIL_NOT_FOUND

Email yêu cầu không tìm thấy hoặc đã hết hạn

Email không tồn tại hoặc đã bị xóa

Yêu cầu ví dụ

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

Đoạn mã

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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Tài liệu

Tham số

truy vấnBắt buộc

include_dashboard

Phải được đặt thành "true" để truy cập email bảng điều khiển. Điều này kích hoạt tính năng premium và tính phí 2 tín dụng.

Ví dụ: true

⚠️ Phải là "true" - Người dùng cấp miễn phí sẽ nhận lỗi 403

truy vấn

include_expired

Bao gồm email đã hết hạn trong phản hồi (email API và email bảng điều khiển)

Ví dụ: false

truy vấn

limit

Số lượng email tối đa để trả về (tối đa: 100)

Ví dụ: 50

⚠️ Phải từ 1 đến 100

Ví dụ lỗi

403

TIER_RESTRICTED

Truy cập email bảng điều khiển yêu cầu gói trả phí (Basic trở lên)

Đây là tính năng premium. Người dùng cấp miễn phí không thể truy cập email bảng điều khiển qua API.

402

INSUFFICIENT_CREDITS

Cần 2 tín dụng để liệt kê email bảng điều khiển

Thao tác này tốn 2 tín dụng. Vui lòng thêm tín dụng vào tài khoản của bạn.

Yêu cầu ví dụ

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

Đoạn mã

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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Tài liệu

Tham số

đường dẫnBắt buộc

ID email bảng điều khiển (định dạng UUID) - Sao chép điều này từ bảng điều khiển của bạn hoặc từ endpoint list-dashboard-emails

Ví dụ: 550e8400-e29b-41d4-a716-446655440000

⚠️ Phải là UUID hợp lệ từ email bảng điều khiển của bạn

truy vấnBắt buộc

include_dashboard

Phải là "true" để tìm kiếm email bảng điều khiển. Tính phí 1 tín dụng.

Ví dụ: true

Ví dụ lỗi

403

TIER_RESTRICTED

Tính năng Premium

Truy cập email bảng điều khiển yêu cầu gói trả phí

402

INSUFFICIENT_CREDITS

Cần 1 tín dụng để truy cập email bảng điều khiển

Thao tác này tốn 1 tín dụng

404

EMAIL_NOT_FOUND

Email không tìm thấy

Email yêu cầu không tìm thấy hoặc đã hết hạn

Yêu cầu ví dụ

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

Đoạn mã

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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Tài liệu

Tham số

đường dẫnBắt buộc

ID email bảng điều khiển - UUID của email mà bạn muốn lấy tin nhắn

Ví dụ: 550e8400-e29b-41d4-a716-446655440000

⚠️ Phải là UUID hợp lệ từ email bảng điều khiển của bạn

truy vấnBắt buộc

include_dashboard

Phải là "true" để truy cập tin nhắn email bảng điều khiển. Tính phí 1 tín dụng.

Ví dụ: true

truy vấn

limit

Số lượng tin nhắn tối đa để trả về mỗi trang (tối đa: 100)

Ví dụ: 20

⚠️ Phải từ 1 đến 100

truy vấn

offset

Số lượng tin nhắn bỏ qua cho phân trang (ví dụ: offset=20 với limit=20 lấy trang 2)

Ví dụ: 0

⚠️ Phải là số nguyên không âm

Ví dụ lỗi

403

TIER_RESTRICTED

Tính năng Premium

Truy cập email bảng điều khiển yêu cầu gói trả phí

402

INSUFFICIENT_CREDITS

Cần 1 tín dụng để truy cập tin nhắn email bảng điều khiển

Thao tác này tốn 1 tín dụng

404

EMAIL_NOT_FOUND

Email không tìm thấy

Email yêu cầu không tìm thấy hoặc đã hết hạn

Yêu cầu ví dụ

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

Đoạn mã

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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Tài liệu

Tham số

đường dẫnBắt buộc

Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding status you want to inspect

Ví dụ: 550e8400-e29b-41d4-a716-446655440000

⚠️ Must be an owned dashboard mailbox ID or permanent API mailbox ID

truy vấnBắt buộc

include_dashboard

Must be set to "true" to access Telegram forwarding mailbox status. Charges 2 credits.

Ví dụ: true

⚠️ Must be "true" - Free tier users will receive a 403 error

Ví dụ lỗi

403

TIER_RESTRICTED

Dashboard email access requires a paid plan (Basic or higher)

This is a premium feature. Free tier users cannot access dashboard email forwarding via API.

402

INSUFFICIENT_CREDITS

Need 2 credits to access dashboard email Telegram forwarding status

This operation costs 2 credits. Please add more credits to your account.

404

EMAIL_NOT_FOUND

Email not found

The requested mailbox was not found, is unsupported, or has expired

Yêu cầu ví dụ

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

Đoạn mã

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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Tài liệu

Tham số

đường dẫnBắt buộc

Mailbox ID - Use a dashboard mailbox ID or a permanent API mailbox ID whose Telegram forwarding you want to update

Ví dụ: 550e8400-e29b-41d4-a716-446655440000

⚠️ Must be an owned dashboard mailbox ID or permanent API mailbox ID

truy vấnBắt buộc

include_dashboard

Must be set to "true" to update Telegram mailbox forwarding. Charges 2 credits.

Ví dụ: true

⚠️ Must be "true" - Free tier users will receive a 403 error

nội dungBắt buộc

is_enabled

Boolean body field. Set true to enable forwarding or false to disable forwarding.

Ví dụ: true

⚠️ Must be a boolean value

Ví dụ lỗi

403

TIER_RESTRICTED

Dashboard email access requires a paid plan (Basic or higher)

This is a premium feature. Free tier users cannot update dashboard email forwarding via API.

402

INSUFFICIENT_CREDITS

Need 2 credits to update dashboard email Telegram forwarding

This operation costs 2 credits. Please add more credits to your account.

400

NO_TELEGRAM_BINDING

No active Telegram binding found. Please bind your Telegram account first.

Forwarding cannot be enabled until the account has an active verified Telegram binding.

403

FORWARDING_LIMIT_EXCEEDED

Forwarding limit exceeded

The user has reached the plan limit for active Telegram forwardings.

404

EMAIL_NOT_FOUND

Email not found

The requested mailbox was not found, is unsupported, or has expired

Yêu cầu ví dụ

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

Đoạn mã

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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Tài liệu

Tham số

truy vấnBắt buộc

include_dashboard

Must be set to "true" to bulk enable Telegram mailbox forwarding. Charges 2 credits.

Ví dụ: true

⚠️ Must be "true" - Free tier users will receive a 403 error

nội dungBắt buộc

email_ids

Body field containing a non-empty array of owned mailbox IDs. In the test form, you can enter a single mailbox ID or a JSON array.

Ví dụ: ["550e8400-e29b-41d4-a716-446655440000"]

⚠️ Must resolve to a non-empty array of owned dashboard mailbox IDs or permanent API mailbox IDs. The bulk limit is 150 IDs per request.

Ví dụ lỗi

403

TIER_RESTRICTED

Dashboard email access requires a paid plan (Basic or higher)

This is a premium feature. Free tier users cannot bulk enable dashboard email forwarding via API.

402

INSUFFICIENT_CREDITS

Need 2 credits to bulk enable dashboard email Telegram forwarding

This operation costs 2 credits total per bulk request.

400

NO_TELEGRAM_BINDING

No active Telegram binding found. Please bind your Telegram account first.

Forwarding cannot be enabled until the account has an active verified Telegram binding.

403

FORWARDING_LIMIT_EXCEEDED

Forwarding limit exceeded

The user has reached the plan limit for active Telegram forwardings.

404

EMAIL_NOT_FOUND

Email not found

No matching forwardable mailboxes were found.

Yêu cầu ví dụ

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

Đoạn mã

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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Tài liệu

Tham số

truy vấn

create_as_dashboard

Đặt thành "true" để tạo email kiểu bảng điều khiển được lưu trong cơ sở dữ liệu với thời gian hết hạn cố định 2 tháng. Nếu bỏ qua, tạo email API dựa trên thời gian trong bộ nhớ. Cả hai đều hỗ trợ custom_username.

Ví dụ: true

⚠️ ⚠️ Email bảng điều khiển tốn 15 tín dụng. Thời gian hết hạn cố định 2 tháng (không có tham số thời gian). Người dùng cấp miễn phí sẽ nhận lỗi 403. Bỏ qua tham số này để tạo email API dựa trên thời gian với tùy chọn thời gian tùy chỉnh.

truy vấn

custom_username

Ví dụ: john.doe

⚠️ ⚠️ Phải có từ 3 đến 30 ký tự. Không thể bắt đầu/kết thúc bằng ký tự đặc biệt. Phải là duy nhất trong tất cả email của bạn. Nếu đã được sử dụng, trả về 409 Conflict.

truy vấn

domain

Tên miền tùy chỉnh tùy chọn cho địa chỉ email. Nếu không được chỉ định, một tên miền công cộng ngẫu nhiên sẽ được sử dụng.

Ví dụ: mail.yourdomain.com

⚠️ Phải là tên miền đã được xác minh trong tài khoản của bạn

Ví dụ lỗi

403

TIER_RESTRICTED

Tính năng Premium

Tạo email bảng điều khiển yêu cầu gói trả phí

402

INSUFFICIENT_CREDITS

Cần 15 tín dụng để tạo email bảng điều khiển

Thao tác này tốn 15 tín dụng

400

INVALID_USERNAME

Tên người dùng phải có ít nhất 3 ký tự

Xác thực tên người dùng tùy chỉnh thất bại. Phải có từ 3 đến 30 ký tự chỉ với các ký tự hợp lệ.

409

EMAIL_IN_USE

Địa chỉ email "[email protected]" đã được sử dụng

Tên người dùng tùy chỉnh đã được sử dụng. Chọn tên người dùng khác.

400

INVALID_TIME_PARAMETER

Tham số thời gian không hợp lệ

Thời gian phải là một trong: 10min, 1hour, 1day, permanent

Yêu cầu ví dụ

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

Đoạn mã

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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Tài liệu

Ví dụ lỗi

401

UNAUTHORIZED

API key không hợp lệ hoặc bị thiếu

API key là bắt buộc và phải hợp lệ

Yêu cầu ví dụ

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

Đoạn mã

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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Tài liệu

Ví dụ lỗi

401

UNAUTHORIZED

API key không hợp lệ hoặc bị thiếu

API key là bắt buộc và phải hợp lệ

Yêu cầu ví dụ

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

Đoạn mã

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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Tài liệu

Ví dụ lỗi

401

UNAUTHORIZED

API key không hợp lệ hoặc bị thiếu

API key là bắt buộc và phải hợp lệ

Yêu cầu ví dụ

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

Đoạn mã

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();

import requests

response = requests.post("https://v1.boomlify.com/api/v1/emails/create", 
  headers={
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  }
)

data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://v1.boomlify.com/api/v1/emails/create");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
  "X-API-Key: YOUR_API_KEY",
  "Content-Type": "application/json"
]);

$response = curl_exec($ch);
$data = json_decode($response, true);
curl_close($ch);

Giới hạn: 60 RPMTrung tâm API

Kiểm thử API