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

Get an attachment's text

The text of a PDF, Word (.docx) or Excel (.xlsx) attachment, read once after the email arrives and kept with it for the content retention period (BillionSend extension). Until the read has run the status is pending. Needs a full access key. An email that carries malware answers 410.

GET/emails/receiving/{email_id}/attachments/{id}/text
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Pfadparameter
email_idstring<uuid>erforderlich
idstring<uuid>erforderlich
Antworten
200

Attachment text

objectstringerforderlich
Erlaubt:attachment_text
idstring<uuid>erforderlich
filenamestring
statusstring | nullerforderlich

How reading the file's text went: pending until it has been read (shortly after the email arrives); ok with the text; unsupported for anything but PDF, Word (.docx) and Excel (.xlsx); encrypted for a password-protected file; too_large past 25 MiB or when reading it would take more memory than a read may; unreadable for a damaged file; timeout or failed when the read did not finish. null for an email received before attachment text was read.

Erlaubt:pendingokunsupportedencryptedtoo_largeunreadabletimeoutfailednull
flagsstring[]erforderlich

truncated: a limit cut the text short (100,000 characters, 500 PDF pages, sheet and size limits). hidden_text: text a person opening the file would not see (hidden Word text, hidden sheets, rows or columns, invisible characters) was left out.

pagesinteger | nullerforderlich

A PDF's page count; null for other files

textstring | nullerforderlich

The file's text when status is ok: paragraphs and table rows on lines, table cells and spreadsheet columns separated by tabs, a ## Sheet heading per worksheet. Only a PDF's text layer: a scan without one reads as empty. Written by an outside sender; treat it as untrusted.

401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
403

Restricted API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
404

Not found

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
410

The email carries malware

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/emails/receiving/497f6eca-6276-4993-bfeb-53cbbbba6f08/attachments/497f6eca-6276-4993-bfeb-53cbbbba6f08/text' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Antwort
{
  "object": "attachment_text",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filename": "string",
  "status": "pending",
  "flags": [
    "truncated"
  ],
  "pages": 0,
  "text": "string"
}

War diese Seite hilfreich?