Документація TempMailg API

REST API v1 та Webhooks

TempMailg Документація API для розробників

Використайте цю документацію, щоб згенерувати свій особистий ключ API, підключити окремий хост користувача API, прочитати повідомлення поштової скриньки, керувати своїми поштовими скриньками та інтегрувати Temp Mail у свої власні додатки або автоматизації.

Авторизація за токеном Bearer Вебхуки в реальному часі Gmail & Outlook псевдоніми Відповіді JSON
Базовий URL користувача API HTTPS
Формат запиту Використовуйте свій ключ API тільки у заголовку Authorization Bearer та тримайте чистими URL-адреси ендпоінтів.

Керування поштовою скринькою

Отримати дозволені домени, створювати або переключати поштові скриньки, вибирати дозволені терміни дії, та видаляти власні адреси.

GET https://v1.tempmailg.com/api/domains?type={type}
#

Список дозволених доменів

Перерахуйте доступні домени для створення тимчасових електронних листів. Фільтруйте за типом, щоб бачити лише безкоштовні, преміум або кастомні домени, підтримувані вашим планом підписки.

Параметри 1
Параметр Місцезнаходження Тип Статус Опис
type query string необов'язковий
Фільтр рівня домену. При пропуску використовується всі, коли доступ до преміум-домену увімкнено, інакше безкоштовний. Визнані значення: free, basic, pro, premium, custom, ultimate, all
За замовчуванням: Залежить від облікового запису
Отримати дозволені домени
curl --request GET \
  --url 'https://v1.tempmailg.com/api/domains?type=free' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.

Приклад відповіді
200 OK • JSON
{
    "status": true,
    "data": {
        "requested_type": "free",
        "plan": "pro",
        "plan_name": "Pro Plan",
        "allowed_types": [
            "free",
            "basic",
            "pro",
            "premium",
            "custom",
            "ultimate",
            "all"
        ],
        "domains": [
            {
                "domain": "example.com",
                "type": "Free",
                "custom": false
            }
        ]
    }
}
Поля відповіді
Поле Тип Опис
status boolean
Чи успішна операція.
data.requested_type string
Застосовано фільтр домену.
data.plan string
Тег поточного плану.
data.plan_name string
Зручна назва поточного плану.
data.allowed_types array<string>
Фільтри домену, доступні цьому обліковому запису. Визнаний фільтр все ще може бути заборонений у вашому плані.
data.domains array
Вибрані домени після фільтрації; порожній масив є допустимим.
data.domains[].domain string
Вибиране доменне ім'я.
data.domains[].type string
Мітка рівня домену, що читається.
data.domains[].custom boolean
Чи є це власним доменом.
POST https://v1.tempmailg.com/api/emails
#

Створити тимчасову скриньку

Створіть власну тимчасову поштову скриньку. Приберіть ім'я користувача та домен для випадкової генерації, або вкажіть дозволене користувацьке ім'я та дозволений домен. Параметр provider може вибирати генерацію псевдоніма Gmail або Outlook.

Параметри 8
Параметр Місцезнаходження Тип Статус Опис
username body string необов'язковий
Опціональне власне ім'я користувача: від 2 до 64 ASCII‑літер, цифр, крапок, підкреслень або дефісів. Потрібен дозвіл плану; також приймається custom_username.
За замовчуванням: Випадково згенеровано
domain body string необов'язковий
Один із дозволених доменів, повернутих GET /domains. При пропуску вибирається випадковий дозволений домен.
За замовчуванням: Випадковий дозволений домен
lifetime body string необов'язковий
допустимі значення:
10m — 10 хвилин 1h — 1 Година 2h — 2 Години 1d — 1 день 1w — 1 Тиждень 1m — 30 днів 3m — 90 днів 6m — 180 днів 1y — 365 днів unlimited — Необмежено
За замовчуванням: Термін дії плану за замовчуванням
provider body string необов'язковий
Провайдер поштової скриньки: standard, gmail_alias, або outlook_alias.
За замовчуванням: standard
pin_enabled body boolean необов'язковий
Опціональний захист PIN для нової поштової скриньки, якщо це дозволено вашим планом. Це не змінює PIN існуючої поштової скриньки.
За замовчуванням: false
pin body string необов'язковий
Потрібно, коли pin_enabled true: PIN з 6 до 8 цифр, переданий як рядок, щоб зберегти провідні нулі.
pin_confirmation body string необов'язковий
Потрібно, коли pin_enabled має значення true. Має точно відповідати pin.
Idempotency-Key header string необов'язковий
Необхідно для створення або видалення, захищеного PIN: стабільний ключ довжиною від 16 до 128 символів. Повторіть ідентичний запит з тим самим ключем, щоб уникнути дублювання роботи.
Необов’язкові параметри тіла: username (користувацьке ім'я, якщо дозволено планом), domain (дозволений домен, напр. example.com), lifetime (допустимі значення: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited), provider (standard, gmail_alias, outlook_alias). Пропустіть термін дії або залиште його порожнім, щоб використати Типовий термін дії електронної пошти, налаштований для вашого поточного щомісячного/річного плану. Надішліть дозволений термін, наприклад 1h, щоб перевизначити це типове значення. Необмежений використовується лише коли він налаштований як типове значення плану або явно запитаний і дозволений. Параметри тіла mailbox_lifetime та email_lifetime також приймаються; перше непорожнє значення має перевагу у такому порядку: lifetime, mailbox_lifetime, email_lifetime. Недійсні або заборонені значення повертають HTTP 422 замість того, щоб без повідомлення вибирати значення за замовчуванням.
Створити поштову скриньку
curl --request POST \
  --url 'https://v1.tempmailg.com/api/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.

Приклад відповіді
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2301,
        "pin_protected": false,
        "email": "demo123@example.com",
        "domain": "example.com",
        "provider": "standard",
        "expire_at": "2026-11-20T02:18:06+00:00",
        "expires_in_seconds": 86399.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:18:06+00:00",
        "email_token": "encrypted-email-token"
    }
}
Поля відповіді
Поле Тип Опис
status boolean
Чи успішна операція.
data.id integer
Ідентифікатор поштової скриньки. Згенеровані ідентифікатори, адреси та токени різняться для кожної скриньки.
data.pin_protected boolean
Чи має ця скринька захист PIN-кодом. PIN-код або його хеш не повертаються.
data.email string
Згенеровано повну адресу поштової скриньки.
data.domain string
Домен створеної поштової скриньки.
data.provider string
Провайдер поштової скриньки: standard, gmail_alias, або outlook_alias.
data.expire_at string|null
Ефективний термін дії у форматі ISO-8601, або null для необмеженої поштової скриньки.
data.expires_in_seconds number|null
Невід'ємна кількість секунд, що залишилася при обчисленні; можливі дробові секунди. Null означає безліміт, а не нуль.
data.mailbox_state string
Поточний стан поштової скриньки: активний, призупинений, прострочений або неактивний.
data.receiving_enabled boolean
Чи ця поштовий ящик наразі приймає вхідні повідомлення.
data.message_count integer
Відоме загальне число повідомлень; може відображати останню синхронізацію поштової скриньки.
data.unread_message_count integer
Відоме число непрочитаних повідомлень; воно може відображати останню синхронізацію поштової скриньки.
data.last_message_received_at string|null
Останній відомий час отриманого повідомлення у форматі ISO-8601 або null, якщо недоступно.
data.message_count_synced_at string|null
Останній час синхронізації кількості повідомлень у форматі ISO-8601 або null до синхронізації.
data.created_at string|null
Час створення поштової скриньки у форматі ISO-8601.
data.email_token string
Непрозоре зашифроване посилання на поштову скриньку. Воно не замінює автентифікацію Bearer, перевірки власності або авторизацію PIN.
data.pin_grant object
Умова: активне створення поштової скриньки, захищеної PIN-кодом, повертає це право читання; звичайне незахищене створення його не включає.
data.pin_grant.mailbox_id integer
ID поштової скриньки, до якої прив’язано умовне право читання.
data.pin_grant.unlock_token string
Непрозорий токен читання для X-Mailbox-Unlock з тією ж обліковою інформацією власника. Тримайте його приватним і в пам'яті; дозвіл на читання не дає права на видалення.
data.pin_grant.scope string
Область, прочитана для умовного гранту створення.
data.pin_grant.idle_timeout_seconds integer
Дозволений час простою для права читання, зазвичай 3600 секунд.
data.pin_grant.absolute_timeout_seconds integer
Максимальний термін дії гранту на читання, зазвичай 86400 секунд.
data.pin_grant.expires_at string
Термін дії поточного дозволу на читання у форматі ISO-8601.
data.pin_grant.absolute_expires_at string
Абсолютний термін дії гранту на читання у форматі ISO-8601. Зміни безпеки можуть скасувати грант раніше.
POST https://v1.tempmailg.com/api/emails/{email}/{username}/{domain}
#

Оновити / Перемкнути поштову скриньку

Створіть або виберіть поштову скриньку за новим ім'ям користувача та доменом після підтвердження володіння поточною скринькою. Це не перейменовує стару скриньку і не змінює її термін дії на місці. Якщо пункт призначення відрізняється, стара скринька залишається в історії і може бути призупинена обмеженнями активних скриньок. Повторне використання вашого власного активного пункту призначення застосовує його запитаний термін дії або типове значення плану.

Параметри 9
Параметр Місцезнаходження Тип Статус Опис
email path string обов’язкове
Поточна повна електронна адреса власної поштової скриньки для переключення. URL‑кодуйте кожен сегмент шляху; кодуйте знак плюс як %2B.
username path string обов’язкове
Новий бажаний логін: 2–64 алфавітно-цифрових символів; залежить від дозволу на кастомні імена користувачів.
domain path string обов’язкове
Нове дозволене доменне ім'я.
lifetime body string необов'язковий
допустимі значення:
10m — 10 хвилин 1h — 1 Година 2h — 2 Години 1d — 1 день 1w — 1 Тиждень 1m — 30 днів 3m — 90 днів 6m — 180 днів 1y — 365 днів unlimited — Необмежено
За замовчуванням: Термін дії плану за замовчуванням
pin_enabled body boolean необов'язковий
Опціональний захист PIN для нової поштової скриньки, якщо це дозволено вашим планом. Це не змінює PIN існуючої поштової скриньки.
За замовчуванням: false
pin body string необов'язковий
Потрібно, коли pin_enabled true: PIN з 6 до 8 цифр, переданий як рядок, щоб зберегти провідні нулі.
pin_confirmation body string необов'язковий
Потрібно, коли pin_enabled має значення true. Має точно відповідати pin.
Idempotency-Key header string необов'язковий
Необхідно для створення або видалення, захищеного PIN: стабільний ключ довжиною від 16 до 128 символів. Повторіть ідентичний запит з тим самим ключем, щоб уникнути дублювання роботи.
X-Mailbox-Unlock header string необов'язковий
Заголовок, лише захищені поштові скриньки: використовуйте read unlock_token. Спочатку надішліть POST pin і scope=read на PIN unlock URL. Залишайте вашу звичайну Bearer автентифікацію. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Використати існуючу поштову скриньку електронної пошти у {email}. Необов'язковий параметр тіла: lifetime (дозволені значення: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Пропустіть термін дії або залиште його порожнім, щоб використати Типовий термін дії електронної пошти, налаштований для вашого поточного щомісячного/річного плану. Надішліть дозволений термін, наприклад 1h, щоб перевизначити це типове значення. Необмежений використовується лише коли він налаштований як типове значення плану або явно запитаний і дозволений. Параметри тіла mailbox_lifetime та email_lifetime також приймаються; перше непорожнє значення має перевагу у такому порядку: lifetime, mailbox_lifetime, email_lifetime. Недійсні або заборонені значення повертають HTTP 422 замість того, щоб без повідомлення вибирати значення за замовчуванням.
Оновити поштову скриньку, що належить користувачеві
curl --request POST \
  --url 'https://v1.tempmailg.com/api/emails/current@example.com/demo123/example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.

Приклад відповіді
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2302,
        "pin_protected": false,
        "email": "demo123@example.com",
        "domain": "example.com",
        "provider": "standard",
        "expire_at": "2026-11-19T02:28:06+00:00",
        "expires_in_seconds": 599.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:18:06+00:00",
        "email_token": "encrypted-email-token"
    }
}
Поля відповіді
Поле Тип Опис
status boolean
Чи успішна операція.
data.id integer
Ідентифікатор поштової скриньки. Згенеровані ідентифікатори, адреси та токени різняться для кожної скриньки.
data.pin_protected boolean
Чи має ця скринька захист PIN-кодом. PIN-код або його хеш не повертаються.
data.email string
Згенеровано повну адресу поштової скриньки.
data.domain string
Домен створеної поштової скриньки.
data.provider string
Провайдер поштової скриньки: standard, gmail_alias, або outlook_alias.
data.expire_at string|null
Ефективний термін дії у форматі ISO-8601, або null для необмеженої поштової скриньки.
data.expires_in_seconds number|null
Невід'ємна кількість секунд, що залишилася при обчисленні; можливі дробові секунди. Null означає безліміт, а не нуль.
data.mailbox_state string
Поточний стан поштової скриньки: активний, призупинений, прострочений або неактивний.
data.receiving_enabled boolean
Чи ця поштовий ящик наразі приймає вхідні повідомлення.
data.message_count integer
Відоме загальне число повідомлень; може відображати останню синхронізацію поштової скриньки.
data.unread_message_count integer
Відоме число непрочитаних повідомлень; воно може відображати останню синхронізацію поштової скриньки.
data.last_message_received_at string|null
Останній відомий час отриманого повідомлення у форматі ISO-8601 або null, якщо недоступно.
data.message_count_synced_at string|null
Останній час синхронізації кількості повідомлень у форматі ISO-8601 або null до синхронізації.
data.created_at string|null
Час створення поштової скриньки у форматі ISO-8601.
data.email_token string
Непрозоре зашифроване посилання на поштову скриньку. Воно не замінює автентифікацію Bearer, перевірки власності або авторизацію PIN.
data.pin_grant object
Умова: активне створення поштової скриньки, захищеної PIN-кодом, повертає це право читання; звичайне незахищене створення його не включає.
data.pin_grant.mailbox_id integer
ID поштової скриньки, до якої прив’язано умовне право читання.
data.pin_grant.unlock_token string
Непрозорий токен читання для X-Mailbox-Unlock з тією ж обліковою інформацією власника. Тримайте його приватним і в пам'яті; дозвіл на читання не дає права на видалення.
data.pin_grant.scope string
Область, прочитана для умовного гранту створення.
data.pin_grant.idle_timeout_seconds integer
Дозволений час простою для права читання, зазвичай 3600 секунд.
data.pin_grant.absolute_timeout_seconds integer
Максимальний термін дії гранту на читання, зазвичай 86400 секунд.
data.pin_grant.expires_at string
Термін дії поточного дозволу на читання у форматі ISO-8601.
data.pin_grant.absolute_expires_at string
Абсолютний термін дії гранту на читання у форматі ISO-8601. Зміни безпеки можуть скасувати грант раніше.
DELETE https://v1.tempmailg.com/api/emails/{email}
#

Видалити поштову скриньку

Видалити власну поштову скриньку та ініціювати очищення її повідомлень і файлів. Збережені записи поштових скриньок можуть бути м'яко видалені внутрішньо; адреса більше не доступна через API.

Параметри 3
Параметр Місцезнаходження Тип Статус Опис
email path string обов’язкове
Повна електронна адреса власної поштової скриньки, яку потрібно видалити. URL‑кодуйте адресу; плюс‑знак кодуйте як %2B.
X-Mailbox-Unlock header string необов'язковий
Заголовок, лише захищені поштові скриньки: використовуйте одноразовий токен розблокування видалення. Спочатку POST pin, scope=delete і action/target_id, що повертаються у відповіді 423 на URL розблокування PIN. Токен читання не може видаляти. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Idempotency-Key header string необов'язковий
Необхідно для створення або видалення, захищеного PIN: стабільний ключ довжиною від 16 до 128 символів. Повторіть ідентичний запит з тим самим ключем, щоб уникнути дублювання роботи.
Видалити поштову скриньку, що належить користувачеві
curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/emails/demo123@example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.

Приклад відповіді
200 OK • JSON
{
    "status": true,
    "message": "Email has been successfully deleted."
}
Поля відповіді
Поле Тип Опис
status boolean
Чи успішна операція.
message string
Результат видалення. Відсутній ресурс повертає HTTP 404.

Gmail & Outlook псевдоніми

Створюйте поштові скриньки‑аліаси Gmail та Outlook/Hotmail з високою репутацією.

POST https://v1.tempmailg.com/api/gmail-alias/emails
#

Створити псевдонім Gmail

Створити нову тимчасову поштову скриньку‑аліас Gmail, що належить автентифікованому користувачеві.

Параметри 8
Параметр Місцезнаходження Тип Статус Опис
mode body string необов'язковий
Режим генерації: auto, dot, plus або plus_dot. Також приймає gmail_alias_mode. Якщо вибір стилю не дозволений, використовується auto.
За замовчуванням: auto
username body string необов'язковий
Необов'язковий власний суфікс псевдоніма: 2 до 32 ASCII‑літер або цифр, нормалізованих до нижнього регістру; залежить від дозволу функції. Також приймає custom_username або alias_username.
За замовчуванням: Автогенеровано
domain body string необов'язковий
Використовуйте випадковий, gmail.com або googlemail.com; також приймається alias_domain. При пропуску або недоступному дозволі вибору домену використовується випадковий.
За замовчуванням: random
lifetime body string необов'язковий
допустимі значення:
10m — 10 хвилин 1h — 1 Година 2h — 2 Години 1d — 1 день 1w — 1 Тиждень 1m — 30 днів 3m — 90 днів 6m — 180 днів 1y — 365 днів unlimited — Необмежено
За замовчуванням: Термін дії плану за замовчуванням
pin_enabled body boolean необов'язковий
Опціональний захист PIN для нової поштової скриньки, якщо це дозволено вашим планом. Це не змінює PIN існуючої поштової скриньки.
За замовчуванням: false
pin body string необов'язковий
Потрібно, коли pin_enabled true: PIN з 6 до 8 цифр, переданий як рядок, щоб зберегти провідні нулі.
pin_confirmation body string необов'язковий
Потрібно, коли pin_enabled має значення true. Має точно відповідати pin.
Idempotency-Key header string необов'язковий
Необхідно для створення або видалення, захищеного PIN: стабільний ключ довжиною від 16 до 128 символів. Повторіть ідентичний запит з тим самим ключем, щоб уникнути дублювання роботи.
Потрібно, щоб дозвіл Gmail Alias API був увімкнений у вашому плані підписки або розблокований за допомогою пакету API Credit. Необов’язкові параметри: mode (auto, dot, plus, plus_dot), username (користувач з власним псевдонімом), domain (наприклад, gmail.com, googlemail.com), lifetime (допустимі значення: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Пропустіть термін дії або залиште його порожнім, щоб використати Типовий термін дії електронної пошти, налаштований для вашого поточного щомісячного/річного плану. Надішліть дозволений термін, наприклад 1h, щоб перевизначити це типове значення. Необмежений використовується лише коли він налаштований як типове значення плану або явно запитаний і дозволений. Параметри тіла mailbox_lifetime та email_lifetime також приймаються; перше непорожнє значення має перевагу у такому порядку: lifetime, mailbox_lifetime, email_lifetime. Недійсні або заборонені значення повертають HTTP 422 замість того, щоб без повідомлення вибирати значення за замовчуванням.
Створити поштову скриньку-аліас Gmail
curl --request POST \
  --url 'https://v1.tempmailg.com/api/gmail-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.

Приклад відповіді
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2305,
        "pin_protected": false,
        "email": "example+alias123@gmail.com",
        "domain": "gmail.com",
        "provider": "gmail_alias",
        "expire_at": "2026-11-19T03:18:06+00:00",
        "expires_in_seconds": 3599.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:18:06+00:00",
        "email_token": "encrypted-email-token"
    }
}
Поля відповіді
Поле Тип Опис
status boolean
Чи успішна операція.
data.id integer
Ідентифікатор поштової скриньки. Згенеровані ідентифікатори, адреси та токени різняться для кожної скриньки.
data.pin_protected boolean
Чи має ця скринька захист PIN-кодом. PIN-код або його хеш не повертаються.
data.email string
Згенеровано повну адресу поштової скриньки.
data.domain string
Домен створеної поштової скриньки.
data.provider string
Провайдер поштової скриньки: standard, gmail_alias, або outlook_alias.
data.expire_at string|null
Ефективний термін дії у форматі ISO-8601, або null для необмеженої поштової скриньки.
data.expires_in_seconds number|null
Невід'ємна кількість секунд, що залишилася при обчисленні; можливі дробові секунди. Null означає безліміт, а не нуль.
data.mailbox_state string
Поточний стан поштової скриньки: активний, призупинений, прострочений або неактивний.
data.receiving_enabled boolean
Чи ця поштовий ящик наразі приймає вхідні повідомлення.
data.message_count integer
Відоме загальне число повідомлень; може відображати останню синхронізацію поштової скриньки.
data.unread_message_count integer
Відоме число непрочитаних повідомлень; воно може відображати останню синхронізацію поштової скриньки.
data.last_message_received_at string|null
Останній відомий час отриманого повідомлення у форматі ISO-8601 або null, якщо недоступно.
data.message_count_synced_at string|null
Останній час синхронізації кількості повідомлень у форматі ISO-8601 або null до синхронізації.
data.created_at string|null
Час створення поштової скриньки у форматі ISO-8601.
data.email_token string
Непрозоре зашифроване посилання на поштову скриньку. Воно не замінює автентифікацію Bearer, перевірки власності або авторизацію PIN.
data.pin_grant object
Умова: активне створення поштової скриньки, захищеної PIN-кодом, повертає це право читання; звичайне незахищене створення його не включає.
data.pin_grant.mailbox_id integer
ID поштової скриньки, до якої прив’язано умовне право читання.
data.pin_grant.unlock_token string
Непрозорий токен читання для X-Mailbox-Unlock з тією ж обліковою інформацією власника. Тримайте його приватним і в пам'яті; дозвіл на читання не дає права на видалення.
data.pin_grant.scope string
Область, прочитана для умовного гранту створення.
data.pin_grant.idle_timeout_seconds integer
Дозволений час простою для права читання, зазвичай 3600 секунд.
data.pin_grant.absolute_timeout_seconds integer
Максимальний термін дії гранту на читання, зазвичай 86400 секунд.
data.pin_grant.expires_at string
Термін дії поточного дозволу на читання у форматі ISO-8601.
data.pin_grant.absolute_expires_at string
Абсолютний термін дії гранту на читання у форматі ISO-8601. Зміни безпеки можуть скасувати грант раніше.
GET https://v1.tempmailg.com/api/outlook-alias/domains
#

Псевдоніми доменів Outlook

Отримати активні домени псевдонімів Outlook / Hotmail, доступні для створення поштових скриньок.

Потрібно, щоб дозвіл Outlook Alias API був увімкнений у вашому плані підписки або розблокований за допомогою пакету API Credit. Вказує, чи розблоковано вибір конкретного домену у вашому плані.
Отримати домени псевдонімів Outlook
curl --request GET \
  --url 'https://v1.tempmailg.com/api/outlook-alias/domains' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.

Приклад відповіді
200 OK • JSON
{
    "status": true,
    "data": {
        "domains": [
            {
                "domain": "outlook.com",
                "type": "Outlook/Hotmail",
                "selectable": true,
                "locked": false,
                "disabled_reason": null
            },
            {
                "domain": "hotmail.com",
                "type": "Outlook/Hotmail",
                "selectable": true,
                "locked": false,
                "disabled_reason": null
            }
        ]
    }
}
Поля відповіді
Поле Тип Опис
status boolean
Чи успішна операція.
data.domains array
Активні домени Outlook/Hotmail; порожній масив є допустимим.
data.domains[].domain string
Доступне доменне ім'я.
data.domains[].type string
Читабельна мітка постачальника.
data.domains[].selectable boolean
Чи може ваш обліковий запис явно вибрати цей домен.
data.domains[].locked boolean
Чи заблоковано явний вибір домену у вашому обліковому записі.
data.domains[].disabled_reason string|null
Причина, чому вибір домену заблоковано, або null, коли вибір можливий.
POST https://v1.tempmailg.com/api/outlook-alias/emails
#

Створити псевдонім Outlook

Створити нову Outlook / Hotmail тимчасову поштову скриньку‑аліас, що належить автентифікованому користувачеві.

Параметри 7
Параметр Місцезнаходження Тип Статус Опис
domain body string необов'язковий
Використовуйте випадковий або домен з GET /outlook-alias/domains; також приймається outlook_alias_domain. Якщо немає дозволу на вибір, використовується випадковий.
За замовчуванням: Випадковий доступний домен
username body string необов'язковий
Необов'язковий власний суфікс псевдоніма: 2 до 32 ASCII‑літер або цифр, нормалізованих до нижнього регістру; залежить від дозволу функції. Також приймає custom_username або alias_username.
За замовчуванням: Автогенеровано
lifetime body string необов'язковий
допустимі значення:
10m — 10 хвилин 1h — 1 Година 2h — 2 Години 1d — 1 день 1w — 1 Тиждень 1m — 30 днів 3m — 90 днів 6m — 180 днів 1y — 365 днів unlimited — Необмежено
За замовчуванням: Термін дії плану за замовчуванням
pin_enabled body boolean необов'язковий
Опціональний захист PIN для нової поштової скриньки, якщо це дозволено вашим планом. Це не змінює PIN існуючої поштової скриньки.
За замовчуванням: false
pin body string необов'язковий
Потрібно, коли pin_enabled true: PIN з 6 до 8 цифр, переданий як рядок, щоб зберегти провідні нулі.
pin_confirmation body string необов'язковий
Потрібно, коли pin_enabled має значення true. Має точно відповідати pin.
Idempotency-Key header string необов'язковий
Необхідно для створення або видалення, захищеного PIN: стабільний ключ довжиною від 16 до 128 символів. Повторіть ідентичний запит з тим самим ключем, щоб уникнути дублювання роботи.
Потрібно, щоб дозвіл Outlook Alias API був увімкнений у вашому плані підписки або розблокований за допомогою пакету API Credit. Необов’язкові параметри: domain (наприклад, outlook.com, hotmail.com), username (користувач з власним псевдонімом), lifetime (допустимі значення: 10m, 1h, 2h, 1d, 1w, 1m, 3m, 6m, 1y, unlimited). Пропустіть термін дії або залиште його порожнім, щоб використати Типовий термін дії електронної пошти, налаштований для вашого поточного щомісячного/річного плану. Надішліть дозволений термін, наприклад 1h, щоб перевизначити це типове значення. Необмежений використовується лише коли він налаштований як типове значення плану або явно запитаний і дозволений. Параметри тіла mailbox_lifetime та email_lifetime також приймаються; перше непорожнє значення має перевагу у такому порядку: lifetime, mailbox_lifetime, email_lifetime. Недійсні або заборонені значення повертають HTTP 422 замість того, щоб без повідомлення вибирати значення за замовчуванням.
Створити псевдонім поштової скриньки Outlook
curl --request POST \
  --url 'https://v1.tempmailg.com/api/outlook-alias/emails' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.

Приклад відповіді
200 OK • JSON
{
    "status": true,
    "data": {
        "id": 2306,
        "pin_protected": false,
        "email": "example+alias45@outlook.com",
        "domain": "outlook.com",
        "provider": "outlook_alias",
        "expire_at": "2026-11-19T03:18:06+00:00",
        "expires_in_seconds": 3599.75,
        "mailbox_state": "active",
        "receiving_enabled": true,
        "message_count": 0,
        "unread_message_count": 0,
        "last_message_received_at": null,
        "message_count_synced_at": null,
        "created_at": "2026-11-19T02:18:06+00:00",
        "email_token": "encrypted-email-token"
    }
}
Поля відповіді
Поле Тип Опис
status boolean
Чи успішна операція.
data.id integer
Ідентифікатор поштової скриньки. Згенеровані ідентифікатори, адреси та токени різняться для кожної скриньки.
data.pin_protected boolean
Чи має ця скринька захист PIN-кодом. PIN-код або його хеш не повертаються.
data.email string
Згенеровано повну адресу поштової скриньки.
data.domain string
Домен створеної поштової скриньки.
data.provider string
Провайдер поштової скриньки: standard, gmail_alias, або outlook_alias.
data.expire_at string|null
Ефективний термін дії у форматі ISO-8601, або null для необмеженої поштової скриньки.
data.expires_in_seconds number|null
Невід'ємна кількість секунд, що залишилася при обчисленні; можливі дробові секунди. Null означає безліміт, а не нуль.
data.mailbox_state string
Поточний стан поштової скриньки: активний, призупинений, прострочений або неактивний.
data.receiving_enabled boolean
Чи ця поштовий ящик наразі приймає вхідні повідомлення.
data.message_count integer
Відоме загальне число повідомлень; може відображати останню синхронізацію поштової скриньки.
data.unread_message_count integer
Відоме число непрочитаних повідомлень; воно може відображати останню синхронізацію поштової скриньки.
data.last_message_received_at string|null
Останній відомий час отриманого повідомлення у форматі ISO-8601 або null, якщо недоступно.
data.message_count_synced_at string|null
Останній час синхронізації кількості повідомлень у форматі ISO-8601 або null до синхронізації.
data.created_at string|null
Час створення поштової скриньки у форматі ISO-8601.
data.email_token string
Непрозоре зашифроване посилання на поштову скриньку. Воно не замінює автентифікацію Bearer, перевірки власності або авторизацію PIN.
data.pin_grant object
Умова: активне створення поштової скриньки, захищеної PIN-кодом, повертає це право читання; звичайне незахищене створення його не включає.
data.pin_grant.mailbox_id integer
ID поштової скриньки, до якої прив’язано умовне право читання.
data.pin_grant.unlock_token string
Непрозорий токен читання для X-Mailbox-Unlock з тією ж обліковою інформацією власника. Тримайте його приватним і в пам'яті; дозвіл на читання не дає права на видалення.
data.pin_grant.scope string
Область, прочитана для умовного гранту створення.
data.pin_grant.idle_timeout_seconds integer
Дозволений час простою для права читання, зазвичай 3600 секунд.
data.pin_grant.absolute_timeout_seconds integer
Максимальний термін дії гранту на читання, зазвичай 86400 секунд.
data.pin_grant.expires_at string
Термін дії поточного дозволу на читання у форматі ISO-8601.
data.pin_grant.absolute_expires_at string
Абсолютний термін дії гранту на читання у форматі ISO-8601. Зміни безпеки можуть скасувати грант раніше.

Повідомлення та вкладення

Отримуйте вхідні поштові скриньки, читайте повні HTML/текстові повідомлення та транслюйте вкладення.

GET https://v1.tempmailg.com/api/messages?email={email}
#

Список повідомлень поштової скриньки

Отримайте доступні підсумки повідомлень та метадані поштової скриньки. Стандартне сканування вхідних повідомлень повертає недавню порцію до 25 повідомлень; це не пагінована кінцева точка повної історії. Використовуйте GET /messages/{messageId} для повних тіл повідомлень та вкладень.

Параметри 2
Параметр Місцезнаходження Тип Статус Опис
email query string обов’язкове
Повна електронна адреса власної поштової скриньки, з якої читати повідомлення. URL-кодуйте значення запиту; кодуйте знак плюс як %2B.
X-Mailbox-Unlock header string необов'язковий
Заголовок, лише захищені поштові скриньки: використовуйте read unlock_token. Спочатку надішліть POST pin і scope=read на PIN unlock URL. Залишайте вашу звичайну Bearer автентифікацію. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Електронна пошта повинна належати вашому обліковому запису. Стандартні та Gmail‑резюме містять поля OTP та verification-link; Outlook також включає from_name, snippet, received_at та has_attachments. Синхронізація та кешування провайдера можуть затримувати нові повідомлення та їх підрахунок.
Прочитати повідомлення поштової скриньки
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages?email=demo123@example.com' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.

Приклад відповіді
200 OK • JSON
{
    "status": true,
    "mailbox": "demo123@example.com",
    "email_token": "encrypted-email-token",
    "messages": [
        {
            "is_seen": false,
            "subject": "Welcome to Temp Mail",
            "from": "Example Sender",
            "from_email": "hello@example.org",
            "receivedAt": "2026-11-19 02:18:06",
            "id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
            "otp": null,
            "otp_locked": false,
            "verification_link": null,
            "verification_link_locked": false
        }
    ],
    "mailbox_provider": "standard",
    "mailbox_state": "active",
    "expire_at": "2026-11-20T02:18:06+00:00",
    "expires_in_seconds": 86399.75,
    "receiving_enabled": true,
    "mailbox_limit": {
        "limit": 50,
        "limit_label": "50",
        "active_count": 1,
        "paused_count": 0,
        "paused_mailboxes": [],
        "remaining": 49,
        "remaining_label": "49",
        "reached": false,
        "blocked": false,
        "provider": "standard"
    },
    "message_count": 1,
    "unread_message_count": 1,
    "last_message_received_at": "2026-11-19T02:18:06+00:00",
    "message_count_synced_at": "2026-11-19T02:18:06+00:00"
}
Поля відповіді
Поле Тип Опис
status boolean
Чи успішна операція.
mailbox string
Адреса поштової скриньки, повідомлення якої були запитані.
email_token string
Непрозоре зашифроване посилання на поштову скриньку; звичайна автентифікація все ще потрібна.
mailbox_provider string
Провайдер поштової скриньки: standard, gmail_alias, або outlook_alias.
messages array
Резюме повідомлень. Порожня вхідна скринька повертає порожній масив; отримайте одне повідомлення для його вмісту та вкладень.
expire_at string|null
Ефективний термін дії у форматі ISO-8601, або null для необмеженої поштової скриньки.
expires_in_seconds number|null
Невід'ємна кількість секунд, що залишилася при обчисленні; можливі дробові секунди. Null означає безліміт, а не нуль.
mailbox_state string
Поточний стан поштової скриньки: активний, призупинений, прострочений або неактивний.
receiving_enabled boolean
Чи ця поштовий ящик наразі приймає вхідні повідомлення.
message_count integer
Відоме загальне число повідомлень; може відображати останню синхронізацію поштової скриньки.
unread_message_count integer
Відоме число непрочитаних повідомлень; воно може відображати останню синхронізацію поштової скриньки.
last_message_received_at string|null
Останній відомий час отриманого повідомлення у форматі ISO-8601 або null, якщо недоступно.
message_count_synced_at string|null
Останній час синхронізації кількості повідомлень у форматі ISO-8601 або null до синхронізації.
mailbox_limit.limit integer
Ліміт активних поштових скриньок для цього провайдера; -1 означає безліміт.
mailbox_limit.limit_label string
Мітка відображення для ліміту поштової скриньки.
mailbox_limit.active_count integer
Кількість активних поштових скриньок для цього провайдера.
mailbox_limit.paused_count integer
Кількість призупинених поштових скриньок для цього провайдера.
mailbox_limit.paused_mailboxes array<string>
Адреси призупинені через обмеження поштової скриньки.
mailbox_limit.remaining integer
Залишилося активних слотів поштових скриньок; -1 означає безліміт. Це не квота запитів API.
mailbox_limit.remaining_label string
Показати мітку для залишкових слотів поштової скриньки.
mailbox_limit.reached boolean
Чи досягнуто ліміту активних поштових скриньок.
mailbox_limit.blocked boolean
Чи дорівнює активне обмеження поштових скриньок нулю.
mailbox_limit.provider string|null
Провайдер, до якого застосовується обмеження поштової скриньки.
messages[].id string
Непрозорий ідентифікатор повідомлення, що використовується кінцевими точками для окремого повідомлення, видалення та вкладення.
messages[].is_seen boolean
Чи позначено повідомлення як прочитане.
messages[].subject string
Тема повідомлення.
messages[].from string
Відображуване ім'я або адреса відправника.
messages[].from_email string
Адреса електронної пошти відправника.
messages[].receivedAt string
Час отримання у часовому поясі застосунку, у форматі YYYY-MM-DD HH:mm:ss.
messages[].otp string|null
Виявлено одноразовий код, коли доступний і дозволений; інакше null.
messages[].otp_locked boolean
Чи приховано виявлений одноразовий код за допомогою дозволів функції.
messages[].verification_link string|null
Виявлено URL-адресу перевірки, коли вона доступна та дозволена; інакше null.
messages[].verification_link_locked boolean
Чи приховано виявлене посилання для підтвердження за допомогою дозволів функції.
messages[].from_name string|null
Поле підсумку Outlook: ім'я оригінального відправника. Відсутнє у стандартних та Gmail підсумках.
messages[].snippet string|null
Поле підсумку Outlook: короткий перегляд повідомлення.
messages[].received_at string|null
Поле підсумку Outlook: час отримання у форматі ISO-8601, якщо відомо.
messages[].has_attachments boolean
Поле підсумку Outlook: чи існує метадані вкладень. Доступність завантаження перевіряється окремо.
GET https://v1.tempmailg.com/api/messages/{messageId}
#

Отримати одне повідомлення

Отримати власне повідомлення за його непрозорим ідентифікатором повідомлення. Повертає формати тіла та метадані вкладень. Поля тіла залежать від формату повідомлення; Outlook додає специфічні для провайдера поля, перелічені нижче.

Параметри 2
Параметр Місцезнаходження Тип Статус Опис
messageId path string обов’язкове
Унікальний ідентифікатор повідомлення, що повертається у списку повідомлень.
X-Mailbox-Unlock header string необов'язковий
Заголовок, лише захищені поштові скриньки: використовуйте read unlock_token. Спочатку надішліть POST pin і scope=read на PIN unlock URL. Залишайте вашу звичайну Bearer автентифікацію. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Прочитати одне повідомлення
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.

Приклад відповіді
200 OK • JSON
{
    "status": true,
    "data": {
        "is_seen": true,
        "subject": "Welcome to Temp Mail",
        "from": "Example Sender",
        "from_email": "hello@example.org",
        "to": "demo123@example.com",
        "mailbox_provider": "standard",
        "receivedAt": "2026-11-19 02:18:06",
        "id": "ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1",
        "html": true,
        "html_content": "<p>Hello from the inbox.</p>",
        "text_content": "<pre>Hello from the inbox.</pre>",
        "content": "<p>Hello from the inbox.</p>",
        "attachments": [
            {
                "name": "file.txt",
                "extension": "txt",
                "size": 91,
                "url": "https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt"
            }
        ]
    }
}
Поля відповіді
Поле Тип Опис
status boolean
Чи успішна операція.
data.id string
Непрозорий ідентифікатор повідомлення.
data.is_seen boolean
Стан прочитання повідомлення. Читання може позначити його як переглянуте; кешовані дані можуть відображати попередній стан.
data.subject string
Тема повідомлення.
data.from string
Відображуване ім'я або адреса відправника.
data.from_email string
Адреса електронної пошти відправника.
data.to string
Адреса поштової скриньки одержувача.
data.mailbox_provider string
Провайдер поштової скриньки: standard, gmail_alias, або outlook_alias.
data.receivedAt string
Час отримання у часовому поясі застосунку, у форматі YYYY-MM-DD HH:mm:ss.
data.html boolean
Чи має повідомлення HTML‑тіло.
data.html_content string
HTML‑тіло, коли присутнє. Стандартні повідомлення без HTML можуть пропускати це поле. Ставтеся до вмісту повідомлення як до ненадійного.
data.text_content string
Текстове тіло, коли присутнє; Стандартні повідомлення можуть містити екранований текст у елементі pre або пропускати це поле.
data.content string
Бажане тіло для відображення, зазвичай HTML, якщо доступно.
data.attachments array
Метадані вкладення, або порожній масив. Завантаження вимагають звичайної автентифікації та відповідної авторизації PIN.
data.attachments[].name string
Ім'я файлу для URL-кодування як один сегмент шляху під час завантаження.
data.attachments[].size integer
Розмір вкладення в байтах.
data.attachments[].url string
URL-адресу завантаження API автентифікованого користувача додано до вкладень з ім'ям файлу. URL-адреса не гарантує, що локальний файл доступний.
data.attachments[].extension string
Стандартне/поле метаданих Gmail: розширення файлу, якщо вказано.
data.attachments[].id string
Поле метаданих Outlook: ідентифікатор вкладення постачальника.
data.attachments[].content_type string
Поле метаданих Outlook: MIME‑тип вмісту.
data.from_name string|null
Поле деталізації Outlook: ім'я оригінального відправника.
data.to_email string|null
Поле деталізації Outlook: адреса оригінального отримувача.
data.received_at string|null
Поле деталізації Outlook: час отримання у форматі ISO-8601.
data.has_html boolean
Поле деталізації Outlook: чи існує HTML‑тіло.
DELETE https://v1.tempmailg.com/api/messages/{messageId}
#

Видалити повідомлення

Видалити одне повідомлення, що належить користувачеві

Параметри 3
Параметр Місцезнаходження Тип Статус Опис
messageId path string обов’язкове
Унікальний рядок ідентифікатора повідомлення для постійного видалення.
X-Mailbox-Unlock header string необов'язковий
Заголовок, лише захищені поштові скриньки: використовуйте одноразовий токен розблокування видалення. Спочатку POST pin, scope=delete і action/target_id, що повертаються у відповіді 423 на URL розблокування PIN. Токен читання не може видаляти. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Idempotency-Key header string необов'язковий
Необхідно для створення або видалення, захищеного PIN: стабільний ключ довжиною від 16 до 128 символів. Повторіть ідентичний запит з тим самим ключем, щоб уникнути дублювання роботи.
Видалити одне повідомлення
curl --request DELETE \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.

Приклад відповіді
200 OK • JSON
{
    "status": true,
    "message": "Message was deleted successfully."
}
Поля відповіді
Поле Тип Опис
status boolean
Чи успішна операція.
message string
Результат видалення. Відсутній ресурс повертає HTTP 404.
GET https://v1.tempmailg.com/api/messages/{messageId}/attachments/{filename}
#

Завантажити вкладення

Завантажити вкладення з повідомлення, яким ви володієте.

Параметри 3
Параметр Місцезнаходження Тип Статус Опис
messageId path string обов’язкове
Ідентифікатор повідомлення, що містить файл.
filename path string обов’язкове
Ім'я файлу та розширення вкладення для завантаження.
X-Mailbox-Unlock header string необов'язковий
Заголовок, лише захищені поштові скриньки: використовуйте read unlock_token. Спочатку надішліть POST pin і scope=read на PIN unlock URL. Залишайте вашу звичайну Bearer автентифікацію. <code>https://v1.tempmailg.com/api/mailboxes/{mailbox}/pin/unlock</code>
Успішний запит повертає байти файлу, а не JSON. Надмірно великі файли повертають HTTP 403; відсутні або недоступні локальні файли повертають HTTP 404. URL-кодуйте ім'я файлу як один сегмент шляху. Метадані вкладення самі по собі не гарантують доступність завантаження.
Завантажити вкладення
curl --request GET \
  --url 'https://v1.tempmailg.com/api/messages/ap94AWDg123ELQz07vrVB9dLXlbqZM5NGwYxOJKko8n6m1/attachments/file.txt' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY' \
  --output file.txt
Поведінка завантаження Ця кінцева точка повертає запитуваний файл напряму замість тіла JSON.
Поля відповіді
Поле Тип Опис
Content-Disposition header
Успішна відповідь завантажує запитане ім'я файлу.
body binary
Байти файлу у випадку успіху, а не JSON. Помилки повертають JSON зі статусом, відмінним від 2xx.

Ліміти швидкості та квоти

Контролюйте бюджети запитів у реальному часі, обмеження швидкості та квоти облікового запису без використання кредитів.

GET https://v1.tempmailg.com/api/rate-limit
#

Обмеження швидкості та квота

Перевірте ваш поточний ліміт запитів та статус квоти без споживання будь‑якого використання API. Цей кінцевий пункт не враховує квоту і не знімає місячні кредити API (обмеження захисту від зловживань: 60 запитів/хв).

X-RateLimit-* описує зазначений бюджет запитів; X-Quota-* описує місячну та придбану місткість, коли вона доступна. X-Mailbox-RateLimit-* повідомляє про окремий бюджет створення/оновлення поштових скриньок. Відмова лише для скриньки використовує область скриньки та власне вікно повторної спроби. Відмови за хвилинним лімітом можуть не містити інформації про квоту. Retry-After включається лише для повторної спроби з таймером; вимкнений доступ може вимагати зміни облікового запису. У цій успішній відповіді статусу, data.limit, data.remaining і data.reset описують щохвилинний бюджет облікового запису, а не витратні кредити. Об’єкт data.quota описує місячну норму, баланси кредитів та їх використання. Існуючі поля data.monthly_limit, data.monthly_remaining і data.purchased_credits залишаються псевдонімами відповідних полів quota. Успішна перевірка статусу не дає права на іншу операцію API. Операції все ще вимагають увімкненого доступу, наявної квоти та проходження всіх застосовних обмежень. Знімок квоти не гарантує доступність ресурсів, вже зарезервованих поточним запитом.
Перевірити статус ліміту запитів
curl --request GET \
  --url 'https://v1.tempmailg.com/api/rate-limit' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_USER_API_KEY'

Ілюстративна відповідь з використанням синтетичних даних. Ідентифікатори, адреси, токени, мітки часу, ліміти плану та кількості різняться. Прикладні терміни дії не замінюють значення за замовчуванням вашого плану. Опис полів відповіді вказує на nullable та provider-specific поля.

Приклад відповіді
200 OK • JSON
{
    "status": "success",
    "data": {
        "limit": 60,
        "remaining": 45,
        "reset": 32,
        "plan": "premium",
        "monthly_limit": 50000,
        "monthly_remaining": 48210,
        "purchased_credits": 5000,
        "quota": {
            "enabled": true,
            "user_api_status": true,
            "plan_name": "Premium Plan",
            "period": "2026-10",
            "base_limit": 50000,
            "extra_requests": 0,
            "monthly_limit": 50000,
            "monthly_remaining": 48210,
            "used": 1790,
            "purchased_credits": 5000,
            "bonus_credits": 1000,
            "direct_purchased_credits": 4000,
            "remaining": 53210,
            "unlimited": false,
            "usage_percent": 3,
            "reset_at": "2026-11-01T00:00:00+00:00"
        }
    }
}
Поля відповіді
Поле Тип Опис
data.limit integer|string
Ліміт запитів облікового запису за хвилину. Рядок unlimited позначає необмежений хвилинний бюджет; це незалежно від місячної квоти.
data.remaining integer|string
Залишкові слоти хвилинного бюджету облікового запису, або рядок unlimited. Позитивне значення не означає, що залишилися кредити API.
data.reset integer
Секунди для хвилинного вікна облікового запису, а не для скидання місячної квоти. Вимкнені або необмежені хвилинні бюджети можуть зберігати номінальне значення 60 секунд; це не гарантує доступ після очікування.
data.plan string
Поточна мітка плану. Читабельна назва плану надається окремо в data.quota.plan_name.
data.quota.enabled boolean
Чи ввімкнено глобальний та плановий/кредитний доступ до API. Це не вказує на залишкову потужність і не замінює перемикач API користувача.
data.quota.user_api_status boolean
Чи користувач увімкнув перемикач User API. Операції вимагають цього перемикача, а також увімкненого доступу та доступної потужності.
data.quota.plan_name string
Зручна назва поточного плану.
data.quota.period string
Період використання календарного місяця у форматі YYYY-MM, з використанням часового поясу застосунку; не обов’язково період виставлення рахунку за підписку.
data.quota.base_limit integer
Базова місячна норма плану. Значення -1 означає безліміт.
data.quota.extra_requests integer
Додатковий місячний ліміт надано для поточного періоду використання; окремо від придбаних кредитів.
data.quota.monthly_limit integer
Базова норма плюс додаткові запити поточного періоду. Значення -1 означає безліміт. Придбані кредити не включені.
data.quota.monthly_remaining integer|null
Залишок обмеженого місячного ліміту, або null, коли місячна квота безлімітна. Null не слід трактувати як нуль.
data.quota.used integer
Успішні, враховані операції API у поточному періоді використання, включаючи операції, що використовують кредити. Перевірки статусу не збільшують це значення.
data.quota.purchased_credits integer
Поточний баланс кредитів, включаючи бонусні кредити активного плану. Бонусні кредити не повинні додаватися до цього балансу вдруге.
data.quota.bonus_credits integer
Активна частина бонусу плану у балансі кредитів; розподіл purchased_credits, а не додаткова місткість.
data.quota.direct_purchased_credits integer
Баланс кредитів без урахування активної частини бонусу плану. Це значення плюс bonus_credits дорівнює purchased_credits.
data.quota.remaining integer|null
Щомісячна залишкова норма плюс поточний баланс кредиту, без подвійного підрахунку бонусів. Null означає необмежену щомісячну квоту. Індивідуальні дозволи функцій та інші обмеження запитів залишаються в силі.
data.quota.unlimited boolean
Чи є місячна квота безлімітною. Це не робить безлімітним бюджет хвилин облікового запису або інші обмеження функцій.
data.quota.usage_percent integer
Сумісний з панеллю інструментів округлений відсоток від 0 до 100: використано поділено на використано плюс залишок, помножено на 100. Включає доступну кредитну потужність, тому поповнення може знизити відсоток. Це 0 для необмеженої квоти або пула нульового розміру; це не відсоток обмеження швидкості за хвилину і не рішення про доступ.
data.quota.reset_at string
Мітка часу ISO-8601 з часовим зміщенням для наступного скидання квоти календарного місяця. Це не дата закінчення підписки, і щомісячне скидання не поповнює придбані кредити.
status string
Буквальний успіх для цього кінцевого пункту статусу. Інші успішні кінцеві пункти поштових скриньок використовують булеве true.
data.monthly_limit integer
Сумісний псевдонім відповідного поля data.quota; не додавайте його знову при розрахунку балансів.
data.monthly_remaining integer|null
Сумісний псевдонім відповідного поля data.quota; не додавайте його знову при розрахунку балансів.
data.purchased_credits integer
Сумісний псевдонім відповідного поля data.quota; не додавайте його знову при розрахунку балансів.

Захист PIN-коду поштової скриньки

Введіть PIN, щоб продовжити. Ваша поштовий ящик залишається розблокованим, доки він активний у цій сесії веб-сайту.

Ви приймаєте файли cookie?

Ми використовуємо файли cookie для покращення вашого браузингового досвіду. Використовуючи цей сайт, ви погоджуєтеся з нашою політикою використання файлів cookie.

Більше