Test Message 1

## Authentication

Tìm hiểu cách lấy và sử dụng khóa API

## Lấy khóa API

Trước khi sử dụng API, bạn cần lấy khóa API. Bạn có thể tạo khóa API của mình trên trang Hồ sơ.

### Sử dụng khóa API

Bao gồm khóa API của bạn trong header yêu cầu cho tất cả các yêu cầu API:

[Code (bash)]
X-API-Key: YOUR_API_KEY
[/Code]

### Ghi chú quan trọng

- Giữ khóa API của bạn an toàn và không để lộ nó ở nơi công cộng
- Khóa API có cùng quyền hạn với tài khoản của bạn, hãy sử dụng cẩn thận
- Nếu khóa API của bạn bị xâm phạm, hãy ngay lập tức tạo lại khóa mới trong trang Hồ sơ của bạn

---

## Email API

Tạo và quản lý email

## Lấy Domain có sẵn

Lấy tất cả domain email có sẵn trong hệ thống.

### Yêu cầu

[Code (bash)]
GET /api/email/domains
[/Code]

### Ví dụ yêu cầu

[Code (bash)]
curl https://chat-tempmail.com/api/email/domains \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### Tham số phản hồi

Tham số | Loại | Mô tả
--------- | ------ | -------
domains | array | Danh sách domain email có sẵn

### Ví dụ phản hồi

[Code (json)]
{
  "domains": [
    "chat-tempmail.com",
    "example.com", 
    "other-domain.com"
  ]
}
[/Code]

## Tạo Email

Tạo một địa chỉ email tạm thời mới.

### Yêu cầu

[Code (bash)]
POST /api/emails/generate
[/Code]

### Tham số yêu cầu

Tham số | Loại | Bắt buộc | Mô tả
--------- | ------ | ---------- | -------
name | string | Có | Tiền tố email
expiryTime | number | Có | Thời gian hết hạn (millisecond)<br/>Giá trị có sẵn:<br/>- 3600000 (1 giờ)<br/>- 86400000 (1 ngày)<br/>- 259200000 (3 ngày)<br/>- 0 (vĩnh viễn)
domain | string | Có | Domain email

### Ví dụ yêu cầu

[Code (bash)]
curl -X POST https://chat-tempmail.com/api/emails/generate \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "test",
    "expiryTime": 3600000,
    "domain": "chat-tempmail.com"
  }'
[/Code]

### Tham số phản hồi

Tham số | Loại | Mô tả
--------- | ------ | -------
id | string | Định danh duy nhất của email (định dạng UUID)
email | string | Địa chỉ email đã tạo (địa chỉ email đầy đủ)

### Ví dụ phản hồi

[Code (json)]
{
  "id": "c2c4f894-c672-4d5b-a918-abca95aff1f7",
  "email": "test@chat-tempmail.com"
}
[/Code]

## Lấy danh sách Email

Lấy tất cả địa chỉ email dưới tài khoản của bạn.

### Yêu cầu

[Code (bash)]
GET /api/emails
[/Code]

### Tham số yêu cầu

Tham số | Loại | Bắt buộc | Mô tả
--------- | ------ | ---------- | -------
cursor | string | Không | Con trỏ phân trang, lấy nextCursor từ phản hồi trước

### Ví dụ yêu cầu

[Code (bash)]
curl https://chat-tempmail.com/api/emails \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### Tham số phản hồi

Tham số | Loại | Mô tả
--------- | ------ | -------
emails | array | Danh sách email (tối đa 20 mục mỗi yêu cầu)
nextCursor | string | Con trỏ trang tiếp theo để lấy thêm dữ liệu
total | number | Tổng số email

### Đối tượng Email trong mảng emails

Tham số | Loại | Mô tả
--------- | ------ | -------
id | string | Định danh duy nhất của email (định dạng UUID)
address | string | Địa chỉ email (địa chỉ email đầy đủ)
userId | string | ID người dùng sở hữu email (định dạng UUID)
createdAt | string | Thời gian tạo email (định dạng ISO 8601)
expiresAt | string | Thời gian hết hạn email (định dạng ISO 8601)

### Ví dụ phản hồi

[Code (json)]
{
  "emails": [
    {
      "id": "e4ff5c14-8a72-48c5-bd13-b5347fb944da",
      "address": "6Tg3VT@chat-tempmail.com",
      "userId": "bd08008d-e944-44b2-a0d0-67f2b528ee6d",
      "createdAt": "2025-04-21T08:30:45.084Z",
      "expiresAt": "2025-04-22T08:30:45.084Z"
    }
  ],
  "nextCursor": "fd13a8df-1465-4fbc-a612-ca7311c31ff2",
  "total": 20
}
[/Code]

## Xóa Email

Xóa địa chỉ email được chỉ định.

### Yêu cầu

[Code (bash)]
DELETE /api/emails/{emailId}
[/Code]

### Tham số yêu cầu

Tham số | Loại | Bắt buộc | Mô tả
--------- | ------ | ---------- | -------
emailId | string | Có | ID Email (tham số đường dẫn)

### Ví dụ yêu cầu

[Code (bash)]
curl -X DELETE "https://chat-tempmail.com/api/emails/99fadf12-6826-490a-9c6c-b0b528d4a8e0" \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### Tham số phản hồi

Tham số | Loại | Mô tả
--------- | ------ | -------
success | boolean | Việc xóa có thành công không

### Ví dụ phản hồi

[Code (json)]
{
  "success": true
}
[/Code]

---

## Message API

Quản lý tin nhắn

## Lấy danh sách tin nhắn

Lấy tất cả tin nhắn trong địa chỉ email được chỉ định.

### Yêu cầu

[Code (bash)]
GET /api/emails/{emailId}
[/Code]

### Tham số yêu cầu

Tham số | Loại | Bắt buộc | Mô tả
--------- | ------ | ---------- | -------
emailId | string | Có | ID Email (tham số đường dẫn)
cursor | string | Không | Con trỏ phân trang (tham số truy vấn), lấy nextCursor từ phản hồi trước

### Ví dụ yêu cầu

[Code (bash)]
curl "https://chat-tempmail.com/api/emails/c2c4f894-c672-4d5b-a918-abca95aff1f7" \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### Tham số phản hồi

Tham số | Loại | Mô tả
--------- | ------ | -------
messages | array | Danh sách tin nhắn (tối đa 20 mục mỗi yêu cầu)
nextCursor | string | Con trỏ trang tiếp theo để lấy thêm dữ liệu
total | number | Tổng số tin nhắn

### Đối tượng tin nhắn trong mảng messages

Tham số | Loại | Mô tả
--------- | ------ | -------
id | string | Định danh duy nhất của tin nhắn (định dạng UUID)
from_address | string | Địa chỉ người gửi
subject | string | Chủ đề tin nhắn
received_at | number | Thời gian nhận (Unix timestamp tính bằng millisecond)

### Ví dụ phản hồi

[Code (json)]
{
  "messages": [
    {
      "id": "fd13a8df-1465-4fbc-a612-ca7311c31ff2",
      "from_address": "sender1@example.com",
      "subject": "Test Message 1 - xJOK2h",
      "received_at": 1745224245084
    }
  ],
  "nextCursor": "eyJ0aW1lc3RhbXAiOjE3NDUxNTU4NDUwODQsImlkIjoiNjNmNzFlODYtOGE1NC00ZDQ0LTk5ZWYtN2QzNTBhMTQ4M2JiIn0=",
  "total": 50
}
[/Code]

## Lấy chi tiết tin nhắn

Lấy nội dung chi tiết của tin nhắn được chỉ định.

### Yêu cầu

[Code (bash)]
GET /api/emails/{emailId}/{messageId}
[/Code]

### Tham số yêu cầu

Tham số | Loại | Bắt buộc | Mô tả
--------- | ------ | ---------- | -------
emailId | string | Có | ID Email (tham số đường dẫn)
messageId | string | Có | ID tin nhắn (tham số đường dẫn)

### Ví dụ yêu cầu

[Code (bash)]
curl "https://chat-tempmail.com/api/emails/99fadf12-6826-490a-9c6c-b0b528d4a8e0/fd13a8df-1465-4fbc-a612-ca7311c31ff2" \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### Tham số phản hồi

Tham số | Loại | Mô tả
--------- | ------ | -------
message | object | Chi tiết tin nhắn

### Trường của đối tượng message

Tham số | Loại | Mô tả
--------- | ------ | -------
id | string | Định danh duy nhất của tin nhắn (định dạng UUID)
from_address | string | Địa chỉ người gửi
subject | string | Chủ đề tin nhắn
content | string | Nội dung văn bản thuần túy của tin nhắn
html | string | Nội dung HTML của tin nhắn (có thể trống)
received_at | number | Thời gian nhận (Unix timestamp tính bằng millisecond)

### Ví dụ phản hồi

[Code (json)]
{
  "message": {
    "id": "fd13a8df-1465-4fbc-a612-ca7311c31ff2",
    "from_address": "sender1@example.com",
    "subject": "Test Message 1 - xJOK2h",
    "content": "Test Message 1\n\nThis is test message 1 content.\n\nBest regards,\nSender 1",
    "html": "<div>\n<h1>Test Message 1</h1>\n </div>",
    "received_at": 1745224245084
  }
}
[/Code]

## Xóa tin nhắn

Xóa tin nhắn được chỉ định.

### Yêu cầu

[Code (bash)]
DELETE /api/emails/{emailId}/{messageId}
[/Code]

### Tham số yêu cầu

Tham số | Loại | Bắt buộc | Mô tả
--------- | ------ | ---------- | -------
emailId | string | Có | ID Email (tham số đường dẫn)
messageId | string | Có | ID tin nhắn (tham số đường dẫn)

### Ví dụ yêu cầu

[Code (bash)]
curl -X DELETE "https://chat-tempmail.com/api/emails/76d91ae5-822a-4fdd-8701-9de038ec86d7/20e77445-b0c3-4e8b-aa29-762ea423ac15" \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### Tham số phản hồi

Tham số | Loại | Mô tả
--------- | ------ | -------
success | boolean | Việc xóa có thành công không

### Ví dụ phản hồi

[Code (json)]
{
  "success": true
}
[/Code]

---

## Webhook Push

Cấu hình webhook để nhận thông báo đẩy tin nhắn

## Lấy cấu hình Webhook

Lấy thông tin cấu hình webhook hiện tại.

### Yêu cầu

[Code (bash)]
GET /api/webhook
[/Code]

### Ví dụ yêu cầu

[Code (bash)]
curl https://chat-tempmail.com/api/webhook \
  -H "X-API-Key: YOUR_API_KEY"
[/Code]

### Tham số phản hồi

Tham số | Loại | Mô tả
--------- | ------ | -------
url | string | Địa chỉ URL webhook (có thể là chuỗi trống)
enabled | boolean | Webhook có được bật không

### Ví dụ phản hồi

[Code (json)]
{
  "url": "https://your-server.com/webhook",
  "enabled": true
}
[/Code]

## Cấu hình Webhook

Đặt hoặc cập nhật cấu hình webhook.

### Yêu cầu

[Code (bash)]
POST /api/webhook
[/Code]

### Tham số yêu cầu

Tham số | Loại | Bắt buộc | Mô tả
--------- | ------ | ---------- | -------
url | string | Có | Địa chỉ URL webhook (phải là URL HTTP/HTTPS hợp lệ)
enabled | boolean | Có | Có bật webhook không

### Ví dụ yêu cầu

[Code (bash)]
curl -X POST https://chat-tempmail.com/api/webhook \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-server.com/webhook",
    "enabled": true
  }'
[/Code]

### Tham số phản hồi

Tham số | Loại | Mô tả
--------- | ------ | -------
success | boolean | Cấu hình có thành công không

### Ví dụ phản hồi

[Code (json)]
{
  "success": true
}
[/Code]

## Sự kiện Webhook

Khi có tin nhắn mới đến, hệ thống sẽ gửi yêu cầu POST đến URL đã cấu hình của bạn.

### Định dạng dữ liệu nhận được

Request Headers:
- Content-Type: application/json
- X-Webhook-Event: new_message

### Dữ liệu đẩy Webhook

Tham số | Loại | Mô tả
--------- | ------ | -------
emailId | string | ID Email nhận tin nhắn (định dạng UUID)
messageId | string | ID tin nhắn mới (định dạng UUID)
fromAddress | string | Địa chỉ người gửi
subject | string | Chủ đề tin nhắn
content | string | Nội dung văn bản thuần túy của tin nhắn
html | string | Nội dung HTML của tin nhắn (có thể trống)
receivedAt | string | Thời gian nhận tin nhắn (định dạng ISO 8601)
toAddress | string | Địa chỉ email nhận tin nhắn

### Ví dụ dữ liệu đẩy

[Code (json)]
{
  "emailId": "c2c4f894-c672-4d5b-a918-abca95aff1f7",
  "messageId": "fd13a8df-1465-4fbc-a612-ca7311c31ff2",
  "fromAddress": "sender@example.com",
  "subject": "Test Message",
  "content": "Message plain text content",
  "html": "<div>Message HTML content</div>",
  "receivedAt": "2025-01-21T08:30:45.084Z",
  "toAddress": "test@chat-tempmail.com"
}
[/Code]

### Yêu cầu phản hồi

Máy chủ của bạn nên trả về mã trạng thái 2xx để chỉ ra việc nhận thành công. Nếu trả về mã trạng thái không phải 2xx, hệ thống có thể thử gửi lại.

Phản hồi được khuyến nghị:

[Code (json)]
HTTP/1.1 200 OK
Content-Type: application/json

{
  "received": true
}
[/Code]

### Ghi chú quan trọng

- Đảm bảo URL webhook của bạn có thể truy cập được
- Khuyến nghị xác minh tính toàn vẹn của dữ liệu đẩy ở phía máy chủ của bạn
- Hệ thống sẽ gửi đẩy webhook ngay lập tức khi tin nhắn đến
- Nếu đẩy thất bại, hệ thống có thể thử lại, vì vậy hãy đảm bảo giao diện của bạn là idempotent

---