Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

List quarantine

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

GET/inboxes/{inbox_id}/quarantine
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Parâmetros de caminho
inbox_idstringobrigatório

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.

Respostas
200

Held messages

objectstringobrigatório
Valores permitidos:list
has_morebooleanobrigatório
dataobject[]obrigatório
Mostrar propriedades
Array de object
idstring<uuid>obrigatório
thread_idstring<uuid> | nullobrigatório
fromstringobrigatório
subjectstring | nullobrigatório
received_atstringobrigatório
quarantine_reasonstringobrigatório
Valores permitidos:failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_cap
sender_truststringobrigatório
Valores permitidos:ownerallowlistedknown_threadexternalunauthenticatedfailed
injection_scoreinteger | nullobrigatório
phishing_scoreinteger | nullobrigatório
virus_signaturestring | nullobrigatório
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
403

Restricted API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Inbox or cursor not found

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

Validation error

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Parâmetros
Requisição
curl -X GET 'https://api.billionsend.com/inboxes/string/quarantine' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "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"
    }
  ]
}

Esta página foi útil?