Muted
Войти
Справочник API

Эндпоинты, доступные в Muted API.

Muted Code IMAP · OAuth2 · TOTP

Достаёт коды подтверждения из почтовых ящиков и генерирует TOTP-токены для двухфакторной авторизации.

Получает код подтверждения из почтового ящика или генерирует TOTP 2FA-токен. Если передан заголовок 2fa, возвращает 6-значный TOTP-токен. Иначе подключается по IMAP и ищет числовой код в последних письмах. Поддерживаются IMAP-ящики популярных сервисов, Outlook по OAuth2, а также mail.tm — у него IMAP нет, код забирается через их HTTP API по тем же email и паролю. Актуальный список сервисов и их доступность — GET /code/providers.

Параметры header
ИмяТипОписание
email string опционально Адрес почты для подключения
password string опционально Пароль от почты или пароль приложения
2fa string опционально Секретный ключ TOTP — если задан, email/password игнорируются
code_length integer опционально Сколько цифр искать (по умолчанию 6)
search_in string опционально subject, body или both (по умолчанию)
sender_filter string опционально Учитывать только письма, отправитель которых содержит это значение
refresh-token string опционально OAuth2 refresh token (Outlook)
client-id string опционально OAuth2 client ID (Outlook)
Ответ — код с почты
{
  "success": true,
  "code": "482916",
  "sender": "Example Service",
  "sender_mail": "[email protected]",
  "mail_date": "2025-01-01T12:00:00+00:00",
  "type": "email"
}
Ответ — 2FA-токен
{
  "success": true,
  "code": "739201",
  "remaining_seconds": 18,
  "type": "2fa"
}
Ответ — ошибка
{
  "success": false,
  "message": "Код не найден."
}

Список почтовых сервисов, из которых Muted Code умеет доставать коды, их домены и текущая доступность. Статусы кэшируются на минуту.

Параметры query
ИмяТипОписание
check boolean опционально Пинговать ли сервисы. false — отдать только реестр без проверок (по умолчанию true)
Ответ
{
  "providers": [
    {
      "id": "mailtm",
      "name": "Mail.tm",
      "site": "https://mail.tm",
      "kind": "api",
      "domains": ["emalupe.com"],
      "status_page": null,
      "check_url": "https://api.mail.tm/domains",
      "status": "up",
      "latency_ms": 339
    }
  ],
  "checked_at": "2025-01-01T12:00:00+00:00"
}