Dokumentasi API

API GPTMail

Gunakan API GPTMail untuk menjana peti masuk sementara, menyenaraikan dan membaca mesej, serta memadam mel melalui HTTPS dengan pengepala X-API-Key. API ini sesuai untuk ujian automatik, saluran paip CI/CD dan aliran kerja QA.

Cara Mendapatkan API Key

Buy API requests

Purchase API requests with GPTMail points. Earn points through daily check-ins and public domains, or buy points with LDC at a 1:1 rate.

Buy with points / add requests

Pilihan 2: Tambah domain anda sendiri

Selepas domain awam lulus pengesahan MX: dihantar tanpa log masuk → kunci API (20000 permintaan); dihantar semasa log masuk → 200 mata. Setiap domain menerima satu ganjaran sahaja. Penting: setelah disambungkan, suffix domain itu menjadi public suffix yang tersedia untuk semua pengguna di tapak ini, jadi pengguna lain juga boleh menjana alamat mailbox di bawahnya. Selepas pengaktifan, jangan padam, gantikan, atau ubah suai rekod MX yang menunjuk domain ini ke perkhidmatan kami. Jika tidak, semakan kemudian mungkin menganggap domain itu salah konfigurasi. Jika semakan kemudian mendapati rekod MX tidak sah, domain akan dinyahaktifkan. Jika rekod MX kekal tidak sah untuk 3 semakan berturut-turut, API Key yang berkaitan juga akan dinyahaktifkan. Jika rekod MX menjadi sah semula kemudian, domain akan diaktifkan semula secara automatik.

Domain

Kunci ujian awam

Untuk ujian, hantar kunci awam kongsi yang dipaparkan di bawah dalam pengepala X-API-Key. Kunci ini bertukar setiap hari dan mempunyai had harian sebanyak 200,000 permintaan yang dikongsi oleh semua pengguna.

Baki Hari Ini

Tetap Semula Dalam

Memuatkan kuota langsung untuk public key...

Rujukan API di bawah boleh disalin sebagai Markdown untuk alat AI, pangkalan pengetahuan, atau README.

URL Asas: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

Mula Pantas

  • X-API-Key: YOUR_KEY ialah pilihan paling mudah. Untuk ujian pantas, gunakan kunci awam harian yang dipaparkan di atas sebagai ganti YOUR_KEY.

  • Kebanyakan endpoint mailbox memerlukan parameter email, contohnya ?email=demo@example.com.

  • Respons API GPTMail menggunakan JSON dengan medan success, data dan error, serta usage apabila kunci API digunakan. Ralat Cloudflare, termasuk respons had kadar, mungkin mengembalikan HTML sebaliknya. Semak status HTTP dan Content-Type sebelum menghuraikan JSON.

  • Jika anda sudah tahu domain yang disokong pada masa ini di tapak ini, anda tidak perlu memanggil endpoint penjanaan email dahulu. Anda boleh menyusun prefix@domain secara setempat dan memanggil API mailbox terus, menjimatkan satu permintaan API.

Had kadar dan cubaan semula

  • GET dan POST /api/generate-email berkongsi had 30 permintaan bagi setiap 10 saat untuk setiap IP sumber. Ini terpakai kepada kunci API awam dan peribadi. Kunci dan klien berbeza di sebalik IP yang sama berkongsi had ini.

  • Melebihi had ini akan mengembalikan HTTP 429 dan menyekat penjanaan alamat e-mel selama 10 saat. Tunggu tempoh Retry-After sebelum mencuba semula. Jika pengepala ini tiada, tunggu sekurang-kurangnya 10 saat, kemudian cuba semula dengan selang masa yang semakin panjang. Elakkan cubaan semula serentak daripada klien yang berkongsi IP.

  • Peraturan ini tidak terpakai kepada penyenaraian peti masuk atau pembacaan e-mel satu per satu. Kuota harian dan jumlah bagi kunci API masih terpakai secara berasingan. Menunggu 10 saat tidak memulihkan kuota kunci yang telah habis.

Endpoint Teras

POST / GET
/api/generate-email

Hasilkan peti masuk sementara. Gunakan GET untuk aliran inbox rawak yang paling ringkas, atau POST dengan prefix dan domain apabila anda mahu kawalan yang jelas.

GET
/api/emails?email=...

Ambil email untuk satu mailbox.

GET
/api/email/{id}?email=...

Dapatkan satu e-mel, termasuk teks, HTML, pengepala mentah dan metadata.

DELETE
/api/email/{id}?email=...

Padam satu email mengikut ID.

DELETE
/api/emails/clear?email=...

Padam semua email dalam satu mailbox.

GET
/api/stats

Baca statistik seluruh tapak.

Aliran Contoh

Di bawah ada dua corak biasa: biarkan perkhidmatan menjana inbox untuk anda, atau minta prefix tetap. Jika anda sudah tahu domain yang disokong pada masa ini, anda juga boleh menyusun mailbox secara setempat dan menanyakannya terus.

1) Jana alamat email sementara rawak

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Contoh respons
{
  "success": true,
  "data": {
    "email": "a3f9c2b1@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 1,
    "remaining_today": 199999,
    "total_limit": 200000,
    "total_usage": 1,
    "remaining_total": 199999
  }
}

2) Jana dengan prefix tetap (cth. demo@example.com)

curl -X POST 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: PUBLIC_API_KEY' \
  -d '{"prefix":"demo"}'
Contoh respons
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) Senaraikan email dalam inbox

Jika anda sudah tahu domain yang disokong, langkau langkah 1 dan tanya terus.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Contoh respons
{
  "success": true,
  "data": {
    "emails": [
      {
        "id": "e5a7f3...",
        "email_address": "demo@example.com",
        "from_address": "noreply@github.com",
        "subject": "Your code: 654321",
        "content": "Your verification code is 654321",
        "html_content": "...",
        "has_html": true,
        "timestamp": 1709654321,
        "created_at": "2024-03-05T12:18:41Z"
      }
    ],
    "count": 1
  }
}

4) Baca satu e-mel — termasuk teks biasa, kandungan HTML dan metadata

Gantikan EMAIL_ID dengan id yang dikembalikan daripada langkah 3. Hantar juga alamat peti masuk sebagai email (termasuk untuk pemadaman dan muat turun lampiran): e-mel itu kemudiannya dibaca terus daripada peti masuknya dan tidak perlu dicari mengikut ID. Dengan kunci API, parameter email adalah pilihan, tetapi menghantarnya menjadikan carian lebih pantas.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Contoh respons
{
  "success": true,
  "data": {
    "id": "e5a7f3...",
    "email_address": "demo@example.com",
    "from_address": "noreply@github.com",
    "subject": "Your code: 654321",
    "content": "Your verification code is 654321",
    "html_content": "<p>Your code is 654321</p>",
    "has_html": true,
    "timestamp": 1709654321,
    "raw_size": 2048,
    "created_at": "2024-03-05T12:18:41Z"
  }
}

5) Padam satu email mengikut ID

Dengan kunci API, parameter email adalah pilihan, tetapi menghantarnya menjadikan carian lebih pantas.

curl -X DELETE 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Contoh respons
{
  "success": true,
  "data": {
    "message": "Email deleted"
  }
}

6) Kosongkan keseluruhan inbox — memadam semua email untuk alamat ini

Setiap panggilan memadam satu kelompok. Selagi respons mengandungi "has_more": true, panggil semula sehingga ia mengembalikan false.

curl -X DELETE 'https://mail.chatgpt.org.uk/api/emails/clear?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
Contoh respons
{
  "success": true,
  "data": {
    "message": "Deleted 3 emails",
    "count": 3,
    "has_more": false
  }
}

Bentuk Respons

Respons berjaya biasanya kelihatan seperti ini. Jika anda mengesahkan dengan API Key, perhatikan maklumat kuota dalam usage.

{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 1,
    "remaining_today": 199999,
    "total_limit": 200000,
    "total_usage": 1,
    "remaining_total": 199999
  }
}

Statistik Lanjutan

  • /api/statistics/24h mengembalikan satu tetingkap taburan setiap jam bagi tempoh 24 jam; gunakan offset=1,2,... untuk tetingkap yang lebih lama.
  • /api/statistics/top-subjects mengembalikan subjek e-mel yang paling kerap.
  • /api/statistics/top-domains memulangkan domain paling aktif.
  • /api/statistics/top-senders memulangkan penghantar paling aktif.
GPTMail