ເອກະສານ API

GPTMail API

ໃຊ້ GPTMail API ເພື່ອສ້າງກ່ອງຈົດໝາຍຊົ່ວຄາວ, ສະແດງລາຍການ ແລະ ອ່ານຂໍ້ຄວາມ, ແລະ ລຶບອີເມວຜ່ານ HTTPS ດ້ວຍສ່ວນຫົວ X-API-Key. ເໝາະສຳລັບການທົດສອບອັດຕະໂນມັດ, ລະບົບ CI/CD ແລະ ຂັ້ນຕອນວຽກ QA.

ວິທີຮັບ 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

ທາງເລືອກ 2: ເພີ່ມ domain ຂອງທ່ານເອງ

ຫຼັງຈາກໂດເມນສາທາລະນະຜ່ານການກວດສອບ MX: ສົ່ງໂດຍບໍ່ເຂົ້າລະບົບ → ກະແຈ API (20000 ຄຳຮ້ອງຂໍ); ສົ່ງຂະນະເຂົ້າລະບົບ → 200 ຄະແນນ. ແຕ່ລະໂດເມນໄດ້ຮັບພຽງໜຶ່ງລາງວັນ. ສຳຄັນ: ເມື່ອເຊື່ອມແລ້ວ suffix domain ນັ້ນກາຍເປັນ public suffix ທີ່ມີໃຫ້ຜູ້ໃຊ້ທັງໝົດ, ດັ່ງນັ້ນຜູ້ໃຊ້ອື່ນກໍສ້າງທີ່ຢູ່ mailbox ພາຍໃຕ້ນັ້ນໄດ້. ຫຼັງເປີດໃຊ້ງານ, ຢ່າລຶບ, ປ່ຽນ, ຫຼືແກ້ MX record ທີ່ຊີ້ domain ນີ້ມາຫາບໍລິການຂອງພວກເຮົາ. ຖ້າບໍ່ດັ່ງນັ້ນການກວດສອບຕໍ່ມາອາດຖືວ່າ domain ຕັ້ງຄ່າບໍ່ຖືກ. ຖ້າກວດພົບ MX record ບໍ່ຖືກ, domain ຈະຖືກປິດ. ຖ້າ MX record ຍັງບໍ່ຖືກຕໍ່ເນື່ອງ 3 ຄັ້ງ, API Key ທີ່ກ່ຽວຂ້ອງກໍຈະຖືກປິດ. ຖ້າ MX record ຖືກອີກຄັ້ງ domain ຈະເປີດໃຊ້ງານຄືນໂດຍອັດຕະໂນມັດ.

ໂດເມນ

ກະແຈທົດສອບສາທາລະນະ

ສຳລັບການທົດສອບ, ໃຫ້ສົ່ງກະແຈສາທາລະນະທີ່ໃຊ້ຮ່ວມກັນທີ່ສະແດງຢູ່ລຸ່ມນີ້ໃນສ່ວນຫົວ X-API-Key. ກະແຈນີ້ປ່ຽນທຸກມື້ ແລະ ມີຂີດຈຳກັດລາຍວັນ 200,000 ຄຳຂໍ ທີ່ຜູ້ໃຊ້ທຸກຄົນໃຊ້ຮ່ວມກັນ.

ເຫຼືອມື້ນີ້

ຣີເຊັດໃນ

ກຳລັງໂຫຼດ quota ສົດສຳລັບ public key...

ເອກະສານອ້າງອີງ API ຂ້າງລຸ່ມສາມາດສຳເນົາເປັນ Markdown ສຳລັບເຄື່ອງມື AI, ຖານຄວາມຮູ້ ຫຼື README.

URL ພື້ນຖານ: https://mail.chatgpt.org.uk

AI
llms.txt

·

llms-full.txt

(Markdown)

ເລີ່ມໄວ

  • X-API-Key: YOUR_KEY ແມ່ນທາງເລືອກທີ່ງ່າຍທີ່ສຸດ. ສຳລັບການທົດສອບດ່ວນ ໃຫ້ໃຊ້ກະແຈສາທາລະນະລາຍວັນທີ່ສະແດງຢູ່ຂ້າງເທິງແທນ YOUR_KEY.

  • Endpoint mailbox ສ່ວນໃຫຍ່ຕ້ອງການ parameter email, ຕົວຢ່າງ ?email=demo@example.com.

  • ການຕອບກັບຂອງ GPTMail API ໃຊ້ JSON ທີ່ມີຊ່ອງ success, data ແລະ error ແລະ ມີ usage ເພີ່ມເມື່ອໃຊ້ກະແຈ API. ຂໍ້ຜິດພາດຂອງ Cloudflare ລວມທັງການຕອບກັບເມື່ອເກີນຂີດຈຳກັດອັດຕາ ອາດສົ່ງຄືນ HTML ແທນ. ກວດສອບສະຖານະ HTTP ແລະ Content-Type ກ່ອນວິເຄາະ JSON.

  • ຖ້າທ່ານຮູ້ domain ທີ່ຮອງຮັບໃນເວັບໄຊນີ້ແລ້ວ, ບໍ່ຈຳເປັນຕ້ອງເອີ້ນ endpoint ສ້າງ email ກ່ອນ. ທ່ານປະກອບ prefix@domain ໃນທ້ອງຖິ່ນແລະເອີ້ນ mailbox APIs ໂດຍກົງ, ປະຢັດ request API ໜຶ່ງ.

ຂີດຈຳກັດອັດຕາຄຳຂໍ ແລະ ການລອງໃໝ່

  • GET ແລະ POST /api/generate-email ໃຊ້ຂີດຈຳກັດຮ່ວມກັນ 30 ຄຳຂໍຕໍ່ 10 ວິນາທີ ຕໍ່ IP ຕົ້ນທາງໜຶ່ງ. ຂີດຈຳກັດນີ້ໃຊ້ກັບທັງກະແຈ API ສາທາລະນະ ແລະ ກະແຈສ່ວນຕົວ. ກະແຈ ແລະ ໂປຣແກຣມລູກຂ່າຍຕ່າງໆທີ່ຢູ່ຫຼັງ IP ດຽວກັນຈະໃຊ້ຂີດຈຳກັດນີ້ຮ່ວມກັນ.

  • ການເກີນຂີດຈຳກັດນີ້ຈະສົ່ງຄືນ HTTP 429 ແລະ ບລັອກການສ້າງອີເມວເປັນເວລາ 10 ວິນາທີ. ລໍຖ້າຕາມໄລຍະເວລາໃນ Retry-After ກ່ອນລອງໃໝ່. ຖ້າບໍ່ມີສ່ວນຫົວນີ້ ໃຫ້ລໍຖ້າຢ່າງໜ້ອຍ 10 ວິນາທີ ແລ້ວລອງໃໝ່ໂດຍເພີ່ມໄລຍະຫ່າງເທື່ອລະໜ້ອຍ. ຫຼີກລ່ຽງການລອງໃໝ່ພ້ອມກັນຈາກໂປຣແກຣມລູກຂ່າຍທີ່ໃຊ້ IP ດຽວກັນ.

  • ກົດນີ້ບໍ່ໃຊ້ກັບການສະແດງລາຍການກ່ອງຈົດໝາຍ ຫຼື ການອ່ານອີເມວແຕ່ລະສະບັບ. ໂຄຕ້າລາຍວັນ ແລະ ໂຄຕ້າລວມຂອງກະແຈ API ຍັງມີຜົນແຍກຕ່າງຫາກ. ການລໍຖ້າ 10 ວິນາທີບໍ່ໄດ້ຟື້ນຟູໂຄຕ້າກະແຈທີ່ໝົດແລ້ວ.

Endpoints ຫຼັກ

POST / GET
/api/generate-email

ສ້າງ inbox ຊົ່ວຄາວ. ໃຊ້ GET ສຳລັບກະແສ inbox ສຸ່ມທີ່ງ່າຍສຸດ, ຫຼື POST ກັບ prefix ແລະ domain ເມື່ອທ່ານຕ້ອງການຄວບຄຸມຢ່າງຊັດເຈນ.

GET
/api/emails?email=...

ດຶງ email ສຳລັບ mailbox ໜຶ່ງ.

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

ດຶງອີເມວໜຶ່ງສະບັບ ລວມທັງຂໍ້ຄວາມ, HTML, ສ່ວນຫົວຕົ້ນສະບັບ ແລະ ຂໍ້ມູນເມຕາ.

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

ລຶບ email ໜຶ່ງຕາມ ID.

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

ລຶບ email ທັງໝົດໃນ mailbox ໜຶ່ງ.

GET
/api/stats

ອ່ານສະຖິຕິທົ່ວເວັບໄຊ.

ຕົວຢ່າງກະແສ

ຂ້າງລຸ່ມນີ້ແມ່ນຮູບແບບທົ່ວໄປສອງແບບ: ໃຫ້ບໍລິການສ້າງ inbox ໃຫ້ທ່ານ, ຫຼືຂໍ prefix ຄົງທີ່. ຖ້າທ່ານຮູ້ domain ທີ່ຮອງຮັບໃນປັດຈຸບັນແລ້ວ, ທ່ານຍັງສາມາດປະກອບ mailbox ໃນທ້ອງຖິ່ນແລະສອບຖາມໂດຍກົງ.

1) ສ້າງທີ່ຢູ່ email ຊົ່ວຄາວແບບສຸ່ມ

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
ຕົວຢ່າງ response
{
  "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) ສ້າງດ້ວຍ prefix ຄົງທີ່ (ເຊັນ 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"}'
ຕົວຢ່າງ response
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) ລາຍການ email ໃນ inbox

ຖ້າທ່ານຮູ້ domain ທີ່ຮອງຮັບແລ້ວ, ຂ້າມຂັ້ນຕອນ 1 ແລະສອບຖາມໂດຍກົງ.

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
ຕົວຢ່າງ response
{
  "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) ອ່ານອີເມວໜຶ່ງສະບັບ — ລວມຂໍ້ຄວາມທຳມະດາ, ເນື້ອຫາ HTML ແລະ ຂໍ້ມູນເມຕາ

ແທນ EMAIL_ID ດ້ວຍ id ທີ່ໄດ້ຮັບຈາກຂັ້ນຕອນທີ 3. ໃຫ້ສົ່ງທີ່ຢູ່ກ່ອງຈົດໝາຍເປັນ email ນຳ (ລວມທັງເວລາລຶບ ແລະ ດາວໂຫຼດໄຟລ໌ແນບ): ອີເມວຈະຖືກອ່ານໂດຍກົງຈາກກ່ອງຈົດໝາຍຂອງມັນ ແທນທີ່ຈະຄົ້ນຫາດ້ວຍ ID. ເມື່ອມີກະແຈ API ພາຣາມິເຕີ email ບໍ່ບັງຄັບ, ແຕ່ການສົ່ງມັນໄປຈະຊ່ວຍໃຫ້ການຄົ້ນຫາໄວຂຶ້ນ.

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
ຕົວຢ່າງ response
{
  "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) ລຶບ email ໜຶ່ງຕາມ ID

ເມື່ອມີກະແຈ API ພາຣາມິເຕີ email ບໍ່ບັງຄັບ, ແຕ່ການສົ່ງມັນໄປຈະຊ່ວຍໃຫ້ການຄົ້ນຫາໄວຂຶ້ນ.

curl -X DELETE 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
ຕົວຢ່າງ response
{
  "success": true,
  "data": {
    "message": "Email deleted"
  }
}

6) ລ້າງ inbox ທັງໝົດ — ລຶບ email ທັງໝົດສຳລັບທີ່ຢູ່ນີ້

ແຕ່ລະການເອີ້ນຈະລຶບໜຶ່ງຊຸດ. ຕາບໃດທີ່ການຕອບກັບມີ "has_more": true ໃຫ້ເອີ້ນອີກຈົນກວ່າຈະສົ່ງຄືນ false.

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

ໂຄງສ້າງ Response

Response ທີ່ສຳເລັດໂດຍປົກກະຕິມີຮູບແບບແບບນີ້. ຖ້າທ່ານພິສູດຕົວຕົນດ້ວຍ API Key, ສັງເກດຂໍ້ມູນ quota ໃນ 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
  }
}

ສະຖິຕິຂະຫຍາຍ

  • /api/statistics/24h ສົ່ງຄືນໜ້າຕ່າງການກະຈາຍລາຍຊົ່ວໂມງ 24 ຊົ່ວໂມງໜຶ່ງໜ້າຕ່າງ; ໃຊ້ offset=1,2,... ສຳລັບໜ້າຕ່າງທີ່ເກົ່າກວ່າ.
  • /api/statistics/top-subjects ສົ່ງຄືນຫົວຂໍ້ອີເມວທີ່ພົບເລື້ອຍທີ່ສຸດ.
  • /api/statistics/top-domains ຄືນ domain ທີ່ເຄື່ອນໄຫວຫຼາຍສຸດ.
  • /api/statistics/top-senders ຄືນຜູ້ສົ່ງທີ່ເຄື່ອນໄຫວຫຼາຍສຸດ.
GPTMail