Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

List quarantine

BillionSend extension: the inbox’s held messages, newest first, metadata only. Not for inbox-scoped keys.

GET/inboxes/{inbox_id}/quarantine
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Parámetros de ruta
inbox_idstringobligatorio

The inbox ID or its email address, such as support@example.com

Parámetros de consulta
limitinteger

Page size, 1-100 (default 20)

mín. 1 · máx. 100
afterstring<uuid>

Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.

beforestring<uuid>

Cursor: id of the first item of the current page; returns the previous page; same rule as after.

Respuestas
200

Held messages

objectstringobligatorio
Valores permitidos:list
has_morebooleanobligatorio
dataobject[]obligatorio
Mostrar propiedades
Array de object
idstring<uuid>obligatorio
thread_idstring<uuid> | nullobligatorio
fromstringobligatorio
subjectstring | nullobligatorio
received_atstringobligatorio
quarantine_reasonstringobligatorio
Valores permitidos:failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_cap
sender_truststringobligatorio
Valores permitidos:ownerallowlistedknown_threadexternalunauthenticatedfailed
injection_scoreinteger | nullobligatorio
phishing_scoreinteger | nullobligatorio
virus_signaturestring | nullobligatorio
401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
403

Restricted API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

Inbox or cursor not found

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
422

Validation error

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Parámetros
Solicitud
curl -X GET 'https://api.billionsend.com/inboxes/string/quarantine' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Respuesta
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
      "from": "string",
      "subject": "string",
      "received_at": "string",
      "quarantine_reason": "failed_auth",
      "sender_trust": "owner",
      "injection_score": 0,
      "phishing_score": 0,
      "virus_signature": "string"
    }
  ]
}

¿Te ha resultado útil esta página?