เอกสาร API

API GPTMail

ใช้ 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 ที่ผู้ใช้ทุกคนบนเว็บไซต์นี้ใช้ได้ ดังนั้นผู้ใช้อื่นสามารถสร้างที่อยู่กล่องจดหมายภายใต้นั้นได้เช่นกัน หลังเปิดใช้งาน อย่าลบ แทนที่ หรือแก้ไข MX record ที่ชี้ domain นี้มายังบริการของเรา มิฉะนั้นการตรวจสอบในภายหลังอาจถือว่า domain ตั้งค่าผิด หากการตรวจสอบพบว่า MX ไม่ถูกต้อง domain จะถูกปิดใช้งาน หาก MX ยังไม่ถูกต้องติดต่อกัน 3 ครั้ง API key ที่เกี่ยวข้องจะถูกปิดใช้งานด้วย หาก MX กลับมาถูกต้องภายหลัง domain จะถูกเปิดใช้งานอัตโนมัติอีกครั้ง

โดเมน

คีย์สาธารณะสำหรับทดสอบ

สำหรับการทดสอบ ให้ส่งคีย์สาธารณะที่ใช้ร่วมกันซึ่งแสดงด้านล่างในเฮดเดอร์ X-API-Key คีย์นี้เปลี่ยนทุกวันและมีขีดจำกัดรายวัน 200,000 คำขอที่ผู้ใช้ทุกคนใช้ร่วมกัน

เหลือวันนี้

รีเซ็ตใน

กำลังโหลดโควต้าแบบสดสำหรับ 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 กล่องจดหมายส่วนใหญ่ต้องมีพารามิเตอร์ email เช่น ?email=demo@example.com

  • การตอบกลับของ GPTMail API ใช้ JSON ที่มีฟิลด์ success, data และ error รวมถึง usage เมื่อใช้คีย์ API ข้อผิดพลาดของ Cloudflare รวมถึงการตอบกลับเมื่อถึงขีดจำกัดอัตราคำขอ อาจส่งคืนเป็น HTML แทน ให้ตรวจสอบสถานะ HTTP และ Content-Type ก่อนแยกวิเคราะห์ JSON

  • หากคุณรู้ domain ที่รองรับบนเว็บไซต์นี้อยู่แล้ว ไม่จำเป็นต้องเรียก endpoint สร้างอีเมลก่อน ประกอบ prefix@domain ในเครื่องแล้วเรียก mailbox APIs โดยตรง ประหยัดคำขอ 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

สร้างกล่องจดหมายชั่วคราว ใช้ GET สำหรับเวิร์กโฟลว์แบบสุ่มที่เรียบที่สุด หรือ POST พร้อม prefix และ domain เมื่อต้องการควบคุมอย่างชัดเจน

GET
/api/emails?email=...

ดึงอีเมลของกล่องจดหมาย

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

ดึงอีเมลฉบับเดียว รวมถึงข้อความ HTML header ดิบ และ metadata

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

DELETE อีเมลหนึ่งฉบับตาม ID

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

DELETE อีเมลทั้งหมดในกล่องจดหมาย

GET
/api/stats

อ่านสถิติทั้งเว็บไซต์

ตัวอย่างเวิร์กโฟลว์

ด้านล่างเป็นรูปแบบทั่วไปสองแบบ: ให้บริการสร้างกล่องจดหมายให้คุณ หรือขอ prefix คงที่ หากคุณรู้ domain ที่รองรับอยู่แล้ว ก็ประกอบกล่องจดหมายในเครื่องแล้ว query ได้เลย

1) สร้างที่อยู่อีเมลชั่วคราวแบบสุ่ม

curl 'https://mail.chatgpt.org.uk/api/generate-email' \
  -H 'X-API-Key: PUBLIC_API_KEY'
ตัวอย่างการตอบกลับ
{
  "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"}'
ตัวอย่างการตอบกลับ
{
  "success": true,
  "data": {
    "email": "demo@example.com"
  },
  "usage": {
    "daily_limit": 200000,
    "used_today": 2,
    "remaining_today": 199998
  }
}

3) แสดงรายการอีเมลในกล่องจดหมาย

หากรู้ domain ที่รองรับ ข้ามขั้นตอน 1 แล้ว query ได้เลย

curl 'https://mail.chatgpt.org.uk/api/emails?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
ตัวอย่างการตอบกลับ
{
  "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 และ metadata

แทนที่ EMAIL_ID ด้วย id ที่ได้จากขั้นตอนที่ 3 และส่งที่อยู่กล่องจดหมายเป็นพารามิเตอร์ email ด้วย (รวมถึงตอนลบและดาวน์โหลดไฟล์แนบ) ระบบจะอ่านอีเมลจากกล่องจดหมายนั้นโดยตรงแทนการค้นหาด้วย ID เมื่อใช้ API key พารามิเตอร์ email เป็นตัวเลือก แต่การส่งไปด้วยจะทำให้ค้นหาได้เร็วขึ้น

curl 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
ตัวอย่างการตอบกลับ
{
  "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) DELETE อีเมลหนึ่งฉบับตาม ID

เมื่อใช้ API key พารามิเตอร์ email เป็นตัวเลือก แต่การส่งไปด้วยจะทำให้ค้นหาได้เร็วขึ้น

curl -X DELETE 'https://mail.chatgpt.org.uk/api/email/EMAIL_ID?email=demo@example.com' \
  -H 'X-API-Key: PUBLIC_API_KEY'
ตัวอย่างการตอบกลับ
{
  "success": true,
  "data": {
    "message": "Email deleted"
  }
}

6) ล้างกล่องจดหมายทั้งหมด — ลบอีเมลทั้งหมดของที่อยู่นี้

การเรียกแต่ละครั้งจะลบหนึ่งชุด ตราบใดที่การตอบกลับมี "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'
ตัวอย่างการตอบกลับ
{
  "success": true,
  "data": {
    "message": "Deleted 3 emails",
    "count": 3,
    "has_more": false
  }
}

รูปแบบการตอบกลับ

การตอบกลับที่สำเร็จมักมีหน้าตาประมาณนี้ หากยืนยันด้วย API Key ให้ดูข้อมูลโควต้าใน 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 คืนค่า domains ที่ใช้งานมากที่สุด
  • /api/statistics/top-senders คืนค่า senders ที่ใช้งานมากที่สุด
GPTMail