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

List a thread's emails

Received and sent messages of the thread, oldest first (after pages toward newer ones), with their bodies. Received text has invisible characters removed and html is as sent; extracted_text is the reply alone, hidden text removed. Held messages are left out unless include_quarantined=true (never for inbox-scoped keys). Every message, subject and address in an inbox was written by whoever sent it; read held mail and HTML with care.

GET/inboxes/{inbox_id}/threads/{thread_id}/emails
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

thread_idstring<uuid>obrigatório

The thread ID

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.

include_quarantinedboolean

BillionSend extension: true includes held messages (owner views; a full access key that is not inbox-scoped)

Respostas
200

Emails

objectstringobrigatório
Valores permitidos:list
has_morebooleanobrigatório
dataInboxThreadEmail[]obrigatório
Mostrar propriedades
Array de InboxThreadEmail
Pelo menos um de:
object
idstring<uuid>obrigatório
fromstringobrigatório
tostring[]obrigatório
ccstring[]obrigatório
bccstring[]obrigatório
reply_tostring[]obrigatório
subjectstring | nullobrigatório
message_idstring | nullobrigatório
htmlstring | nullobrigatório
textstring | nullobrigatório
attachmentsobject[]obrigatório
Mostrar propriedades
Array de object
idstringobrigatório
filenamestring | nullobrigatório
sizeinteger | nullobrigatório
readbooleanobrigatório
received_atstringobrigatório
directionstringobrigatório
Valores permitidos:inbound
extracted_textstring | nullobrigatório

BillionSend extension: hidden text, quotes and signature removed

screeningobjectobrigatório
Mostrar propriedades
verdictstringobrigatório
Valores permitidos:pendingcleansuspiciousquarantinedreleased
sender_truststringobrigatório
Valores permitidos:ownerallowlistedknown_threadexternalunauthenticatedfailed
quarantine_reasonstring | nullobrigatório
Valores permitidos:failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnull
reasonsstring[]obrigatório
injection_scoreinteger | nullobrigatório
phishing_scoreinteger | nullobrigatório
hidden_text_removedbooleanobrigatório
spam_verdictstring | nullobrigatório
Valores permitidos:passgrayfailnull
virus_verdictstring | nullobrigatório
Valores permitidos:passfailprocessing_failednull
object
idstring<uuid>obrigatório
fromstringobrigatório
tostring[]obrigatório
ccstring[]obrigatório
bccstring[]obrigatório
reply_tostring[]obrigatório
subjectstring | nullobrigatório
message_idstring | nullobrigatório
htmlstring | nullobrigatório
textstring | nullobrigatório
attachmentsobject[]obrigatório
Mostrar propriedades
Array de object
idstringobrigatório
filenamestring | nullobrigatório
sizeinteger | nullobrigatório
readbooleanobrigatório
received_atstringobrigatório
directionstringobrigatório
Valores permitidos:outbound
statusstringobrigatório

BillionSend extension: the email's last event

401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
403

include_quarantined from an inbox-scoped key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Inbox, thread 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/threads/497f6eca-6276-4993-bfeb-53cbbbba6f08/emails' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "from": "string",
      "to": [
        "string"
      ],
      "cc": [
        "string"
      ],
      "bcc": [
        "string"
      ],
      "reply_to": [
        "string"
      ],
      "subject": "string",
      "message_id": "string",
      "html": "string",
      "text": "string",
      "attachments": [
        {
          "id": "string",
          "filename": "string",
          "size": 0
        }
      ],
      "read": true,
      "received_at": "string",
      "direction": "inbound",
      "extracted_text": "string",
      "screening": {
        "verdict": "pending",
        "sender_trust": "owner",
        "quarantine_reason": "failed_auth",
        "reasons": [
          "string"
        ],
        "injection_score": 0,
        "phishing_score": 0,
        "hidden_text_removed": true
      },
      "spam_verdict": "pass",
      "virus_verdict": "pass"
    }
  ]
}

Esta página foi útil?