Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

List quarantine

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

GET/inboxes/{inbox_id}/quarantine
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Pfadparameter
inbox_idstringerforderlich

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

Query-Parameter
limitinteger

Page size, 1-100 (default 20)

min. 1 · max. 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.

Antworten
200

Held messages

objectstringerforderlich
Erlaubt:list
has_morebooleanerforderlich
dataobject[]erforderlich
Eigenschaften anzeigen
Array von object
idstring<uuid>erforderlich
thread_idstring<uuid> | nullerforderlich
fromstringerforderlich
subjectstring | nullerforderlich
received_atstringerforderlich
quarantine_reasonstringerforderlich
Erlaubt:failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_cap
sender_truststringerforderlich
Erlaubt:ownerallowlistedknown_threadexternalunauthenticatedfailed
injection_scoreinteger | nullerforderlich
phishing_scoreinteger | nullerforderlich
virus_signaturestring | nullerforderlich
401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
403

Restricted API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
404

Inbox or cursor not found

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Validation error

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Anfrage
curl -X GET 'https://api.billionsend.com/inboxes/string/quarantine' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Antwort
{
  "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"
    }
  ]
}

War diese Seite hilfreich?