Получить результаты

curl --request GET \
  --url https://taimly.net/api/spam-check/{check_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://taimly.net/api/spam-check/{check_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "check_id": "a1b2c3d4e5f6",
  "status": "pending",
  "received": 2,
  "total": 5,
  "results": [
    {
      "email": "inbox1@gmail.com",
      "category": "primary"
    },
    {
      "email": "inbox2@gmail.com",
      "category": "spam"
    },
    {
      "email": "inbox3@gmail.com",
      "category": "pending"
    },
    {
      "email": "inbox4@gmail.com",
      "category": "pending"
    },
    {
      "email": "inbox5@gmail.com",
      "category": "pending"
    }
  ]
}

Spam Check

Получить результаты

Возвращает текущий статус проверки и результат по каждому тестовому аккаунту.

Опрашивайте каждые 5–15 секунд, пока status не станет complete или timeout.

По умолчанию в каждом результате только email и category. Данные письма (отправитель, тема, SMTP, SPF/DKIM/DMARC, IP, PTR, тело, оригинал) добавляются через параметр fields — см. Данные письма.

Категории primary и updates считаются попаданием во Входящие (Inbox). Остальные (promotions, social, forums, spam, trash) — нет.

GET

api

spam-check

{check_id}

Получить результаты

curl --request GET \
  --url https://taimly.net/api/spam-check/{check_id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://taimly.net/api/spam-check/{check_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "check_id": "a1b2c3d4e5f6",
  "status": "pending",
  "received": 2,
  "total": 5,
  "results": [
    {
      "email": "inbox1@gmail.com",
      "category": "primary"
    },
    {
      "email": "inbox2@gmail.com",
      "category": "spam"
    },
    {
      "email": "inbox3@gmail.com",
      "category": "pending"
    },
    {
      "email": "inbox4@gmail.com",
      "category": "pending"
    },
    {
      "email": "inbox5@gmail.com",
      "category": "pending"
    }
  ]
}

Authorizations

Authorization

string

header

required

API-ключ. Передаётся в заголовке Authorization: Bearer <ваш_ключ>. Ключ выдаётся администратором Taimly.

Path Parameters

check_id

string

required

Идентификатор проверки из ответа POST /api/spam-check/start

Example:

"a1b2c3d4e5f6"

Query Parameters

fields

string

Какие данные письма вернуть — имена полей через запятую. Без параметра — только email и category.

Доступно: sender_name, sender_email, subject, reply_to, smtp, sender_ip, ptr, ip_type, spf, dkim, dmarc, has_attachments, body_text, body_html, raw.

body_text, body_html и raw тяжёлые — запрашивайте их один раз, когда status = complete, а не на каждом опросе. Неизвестное имя поля → 400.

Example:

"sender_name,subject,spf,dkim,dmarc,ip_type"

Response

Результаты проверки

check_id

string

required

Идентификатор проверки

Example:

"a1b2c3d4e5f6"

status

enum<string>

required

pending — ждём письма, complete — получены все, timeout — прошло 5 минут, а пришли не все. Результаты доступны 30 минут после старта.

Available options:

pending,

complete,

timeout

received

integer

required

Количество аккаунтов, получивших письмо

Example:

3

total

integer

required

Общее количество тестовых аккаунтов

Example:

5

results

object[]

required

Результаты по каждому аккаунту

Show child attributes