Rujukan API

Hantar e-mel

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.

Gambaran keseluruhan

Titik akhirhttps://api.unbox.im/v1/email
KaedahPOST
Jenis Kandunganapplication/json
SkopSatu kunci API setiap domain tersuai

Hasilkan kunci di Akaun → Domain → domain anda → API selepas pengesahan DNS selesai. Rahsia penuh ditunjukkan sekali sahaja — simpannya dengan selamat. Kelayakan SMTP pilihan di panel Domain yang sama mengikut peraturan hanya transaksional yang sama.

Mel transaksional sahaja

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.

Penggunaan yang dibenarkan

  • Pengesahan akaun, penetapan semula kata laluan, dan amaran keselamatan
  • Pengesahan pesanan, resit, kemas kini penghantaran, dan notis pembayaran
  • Pemberitahuan yang dicetuskan oleh pengguna atau peristiwa sistem tertentu
  • Mesej pasukan dan ruang kerja (jemputan, tugasan, amaran dalaman)

Penggunaan yang dilarang

  • Surat berita, kempen promosi, atau pemasaran siaran
  • Jangkauan sejuk atau mel ke senarai yang dibeli, dikikis, atau tanpa persetujuan
  • Spam afiliasi, pancingan data, atau kandungan menipu
  • Sebarang percubaan untuk memintas had penerima, had kadar, atau kuota pelan

Had kadar dan penerima

Untuk melindungi penerima dan kebolehsampaian, trafik API dan SMTP keluar tertakluk kepada had di bawah (sebagai tambahan kepada kuota keluar bulanan pelan anda). Penguatkuasaan berkuat kuasa pada penggubah web, HTTP API, dan penghantaran SMTP. Penggubah web memberi amaran selepas 25 penerima setiap mesej dan menyekat penghantaran melebihi 50.

HadNilai
Penerima setiap mesejSehingga 50 jumlah (To + Cc + Bcc digabungkan)
Penerima unik setiap hariSehingga 1,000 setiap ruang kerja
Kadar permintaan hantarSehingga 10 penghantaran API atau SMTP seminit setiap domain
Kuota keluar pelanHad penghantaran bulanan pada langganan anda masih terpakai

Peraturan ini adalah sebahagian daripada Dasar Penggunaan Boleh Terima kami. Penguatkuasaan automatik berkuat kuasa pada penggubah web, HTTP API, dan penghantaran SMTP. Akaun yang menghantar pemasaran atau mel pukal, atau menyalahgunakan infrastruktur penghantaran, mungkin dihadkan, digantung, atau ditamatkan.

Kami memantau isyarat kebolehsampaian. Kadar lantunan berterusan melebihi 3% atau kadar aduan melebihi 0.1% mungkin mencetuskan jeda penghantaran sementara atau semakan manual.

Lihat Terma Perkhidmatan, Dasar Privasi, dan Kenyataan GDPR kami untuk butiran dasar penuh.

Pengesahan

Hantar kunci API domain anda pada setiap permintaan:

Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxx

Atau, gunakan X-Api-Key: ubk_live_…. Kunci disimpan dalam bentuk hash; batalkan atau putar dari papan pemuka Domain.

Badan permintaan

JSON dengan nama medan PascalCase (From, To, …). Alias camelCase juga diterima.

MedanDiperlukanPenerangan
FromYaPenghantar — peti mel peribadi anda pada domain kunci (utama atau alias). Giliran dikongsi bukan penghantar yang sah.
ToYaPenerima — rentetan, rentetan dipisah koma, atau tatasusunan
SubjectYaBaris subjek
TextBodySalah satu TextBody / HtmlBodyBadan teks biasa
HtmlBodySalah satu TextBody / HtmlBodyBadan HTML
CcTidakPenerima salinan
BccTidakPenerima salinan buta
ReplyToTidakAlamat Balas-Kepada
TagTidakTag metadata pilihan (disimpan bersama penghantaran)

Contoh

{
  "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"
}

Respons kejayaan

HTTP 200 dengan JSON:

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

Respons ralat

Ralat mengembalikan 4xx (atau 500 untuk kegagalan tidak dijangka) dengan JSON:

{
  "ErrorCode": 300,
  "Message": "TextBody or HtmlBody is required."
}
Kod RalatMaksud
0Berjaya
10Kunci API hilang
11Kunci tidak sah atau telah dibatalkan, atau domain belum disahkan untuk penghantaran
300Ralat pengesahan (medan hilang, JSON tidak sah, dll.)
403Alamat dari tidak dibenarkan — mestilah peti mel peribadi anda di domain kunci tersebut
406SES menolak mesej

Contoh

Gantikan you@yourdomain.com dengan peti mel peribadi anda pada domain dan gunakan kunci API anda sendiri.

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"
}'

Memulakan

  1. Buat akaun Unbox dan tambah domain tersuai anda.
  2. Lengkapkan semua langkah pengesahan DNS di Domains.
  3. Buka Domains → domain anda → API dan hasilkan kunci domain.
  4. Hantar mesej pertama anda dengan contoh di atas.
Unbox — Dokumen API | Unbox.im