Tài liệu tham khảo API

Gửi email

Send transactional mail only from your verified custom domains over HTTPS — password resets, receipts, alerts, and similar event-driven messages. Not for newsletters or marketing bulk. One endpoint, domain-scoped API keys, delivery through AWS SES.

Tổng quan

Điểm cuốihttps://api.unbox.im/v1/email
Phương thứcPOST
Content-Typeapplication/json
Phạm viMột khóa API cho mỗi tên miền tùy chỉnh

Tạo khóa trong Tài khoản → Tên miền → tên miền của bạn → API sau khi xác minh DNS hoàn tất. Toàn bộ bí mật được hiển thị một lần — hãy lưu trữ an toàn. Thông tin đăng nhập SMTP tùy chọn trong cùng bảng Tên miền tuân theo cùng các quy tắc chỉ thư giao dịch.

Chỉ thư giao dịch

Unbox HTTP API (POST /v1/email) and optional SMTP submission are for transactional mail only — messages tied to an account action, purchase, or operational event. They are not a newsletter or marketing broadcast service.

Các mục đích sử dụng được phép

  • Xác minh tài khoản, đặt lại mật khẩu và cảnh báo bảo mật
  • Xác nhận đơn hàng, hóa đơn, cập nhật vận chuyển và thông báo thanh toán
  • Thông báo được kích hoạt bởi một sự kiện người dùng hoặc hệ thống cụ thể
  • Tin nhắn nhóm và không gian làm việc (lời mời, phân công, cảnh báo nội bộ)

Các mục đích sử dụng bị cấm

  • Bản tin, chiến dịch quảng cáo hoặc tiếp thị hàng loạt
  • Tiếp cận lạnh hoặc gửi thư đến danh sách mua, thu thập hoặc không có sự đồng ý
  • Spam liên kết, lừa đảo hoặc nội dung lừa gạt
  • Mọi nỗ lực vượt qua giới hạn người nhận, giới hạn tốc độ hoặc hạn mức gói

Giới hạn tốc độ và người nhận

Để bảo vệ người nhận và khả năng gửi thành công, lưu lượng API và SMTP gửi đi phải tuân theo các giới hạn dưới đây (ngoài hạn mức gửi đi hàng tháng của gói bạn). Việc thực thi được áp dụng trên web composer, HTTP API và SMTP submission. Web composer cảnh báo sau 25 người nhận mỗi tin nhắn và chặn gửi trên 50.

Giới hạnGiá trị
Người nhận mỗi tin nhắnTối đa 50 tổng cộng (To + Cc + Bcc kết hợp)
Người nhận duy nhất mỗi ngàyTối đa 1.000 mỗi không gian làm việc
Tốc độ yêu cầu gửiTối đa 10 lần gửi API hoặc SMTP mỗi phút mỗi tên miền
Hạn mức gửi đi của góiGiới hạn gửi hàng tháng trong gói đăng ký của bạn vẫn được áp dụng

Các quy tắc này là một phần trong Chính sách Sử dụng Chấp nhận được của chúng tôi. Việc thực thi tự động được áp dụng trên web composer, HTTP API và SMTP submission. Các tài khoản gửi thư tiếp thị hoặc thư hàng loạt, hoặc lạm dụng cơ sở hạ tầng gửi thư, có thể bị giới hạn, tạm ngưng hoặc chấm dứt.

Chúng tôi theo dõi các tín hiệu về khả năng gửi thành công. Tỷ lệ bounce duy trì trên 3% hoặc tỷ lệ khiếu nại trên 0,1% có thể kích hoạt tạm dừng gửi hoặc xem xét thủ công.

Xem Điều khoản Dịch vụ, Chính sách Bảo mậtTuyên bố GDPR của chúng tôi để biết chi tiết đầy đủ về chính sách.

Xác thực

Gửi khóa API tên miền của bạn trong mọi yêu cầu:

Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxx

Ngoài ra, sử dụng X-Api-Key: ubk_live_…. Các khóa được lưu trữ dưới dạng băm; thu hồi hoặc xoay vòng từ bảng điều khiển Tên miền.

Nội dung yêu cầu

JSON với tên trường PascalCase (From, To, …). Các bí danh camelCase cũng được chấp nhận.

TrườngBắt buộcMô tả
FromNgười gửi — hộp thư cá nhân của bạn trên tên miền của khóa (chính hoặc bí danh). Hàng đợi chia sẻ không phải là người gửi hợp lệ.
ToNgười nhận — chuỗi, chuỗi phân cách bằng dấu phẩy, hoặc mảng
SubjectDòng chủ đề
TextBodyMột trong TextBody / HtmlBodyNội dung văn bản thuần
HtmlBodyMột trong TextBody / HtmlBodyNội dung HTML
CcKhôngNgười nhận bản sao
BccKhôngNgười nhận bản sao ẩn
ReplyToKhôngĐịa chỉ Reply-To
TagKhôngThẻ metadata tùy chọn (được lưu cùng với lần gửi)

Ví dụ

{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}

Phản hồi thành công

HTTP 200 với JSON:

{
  "ErrorCode": 0,
  "Message": "OK",
  "MessageID": "0100018…-000000-…",
  "SubmittedAt": "2026-06-23T12:00:00.000Z",
  "To": "user@example.com"
}

Phản hồi lỗi

Lỗi trả về 4xx (hoặc 500 cho lỗi không mong đợi) với JSON:

{
  "ErrorCode": 300,
  "Message": "TextBody or HtmlBody is required."
}
Mã lỗiÝ nghĩa
0Thành công
10Thiếu khóa API
11Khóa không hợp lệ hoặc đã bị thu hồi, hoặc tên miền chưa được xác minh để gửi
300Lỗi xác thực (thiếu trường, JSON không hợp lệ, v.v.)
403Địa chỉ người gửi không được phép — phải là hộp thư cá nhân của bạn trên tên miền của khóa
406SES đã từ chối tin nhắn

Ví dụ

Thay thế you@yourdomain.com bằng hộp thư cá nhân của bạn trên tên miền và sử dụng khóa API của riêng bạn.

curl "https://api.unbox.im/v1/email" \
  -H "Authorization: Bearer ubk_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}'

Bắt đầu

  1. Tạo tài khoản Unbox và thêm tên miền tùy chỉnh của bạn.
  2. Hoàn thành tất cả các bước xác minh DNS trong mục Domains.
  3. Mở Domains → tên miền của bạn → API và tạo khóa tên miền.
  4. Gửi tin nhắn đầu tiên của bạn với các ví dụ ở trên.
Unbox — Tài liệu API | Unbox.im