跳到内容
Esc
↑↓导航↵打开⌘J预览

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
授权
AuthorizationBearer 令牌 · header必填

A BillionSend API key (bs_…).

路径参数
inbox_idstring必填

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

thread_idstring<uuid>必填

The thread ID

查询参数
limitinteger

Page size, 1-100 (default 20)

最小值 1 · 最大值 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)

响应
200

Emails

objectstring必填
允许值:list
has_moreboolean必填
dataInboxThreadEmail[]必填
显示属性
InboxThreadEmail 数组
任意项:
object
idstring<uuid>必填
fromstring必填
tostring[]必填
ccstring[]必填
bccstring[]必填
reply_tostring[]必填
subjectstring | null必填
message_idstring | null必填
htmlstring | null必填
textstring | null必填
attachmentsobject[]必填
显示属性
object 数组
idstring必填
filenamestring | null必填
sizeinteger | null必填
readboolean必填
received_atstring必填
directionstring必填
允许值:inbound
extracted_textstring | null必填

BillionSend extension: hidden text, quotes and signature removed

screeningobject必填
显示属性
verdictstring必填
允许值:pendingcleansuspiciousquarantinedreleased
sender_truststring必填
允许值:ownerallowlistedknown_threadexternalunauthenticatedfailed
quarantine_reasonstring | null必填
允许值:failed_authunauthenticated_sendernot_allowlistedinjectionphishingvirusunscreenedscreening_capnull
reasonsstring[]必填
injection_scoreinteger | null必填
phishing_scoreinteger | null必填
hidden_text_removedboolean必填
spam_verdictstring | null必填
允许值:passgrayfailnull
virus_verdictstring | null必填
允许值:passfailprocessing_failednull
object
idstring<uuid>必填
fromstring必填
tostring[]必填
ccstring[]必填
bccstring[]必填
reply_tostring[]必填
subjectstring | null必填
message_idstring | null必填
htmlstring | null必填
textstring | null必填
attachmentsobject[]必填
显示属性
object 数组
idstring必填
filenamestring | null必填
sizeinteger | null必填
readboolean必填
received_atstring必填
directionstring必填
允许值:outbound
statusstring必填

BillionSend extension: the email's last event

401

Missing, malformed, unknown or revoked API key

statusCodenumber必填
namestring必填
messagestring必填
403

include_quarantined from an inbox-scoped key

statusCodenumber必填
namestring必填
messagestring必填
404

Inbox, thread or cursor not found

statusCodenumber必填
namestring必填
messagestring必填
422

Validation error

statusCodenumber必填
namestring必填
messagestring必填
429

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

statusCodenumber必填
namestring必填
messagestring必填
试一试
服务器
授权
参数
请求
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'
响应
{
  "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"
    }
  ]
}

这个页面有帮助吗?