Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

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
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Parámetros de ruta
email_idstring<uuid>obligatorio
idstring<uuid>obligatorio
Respuestas
200

Attachment text

objectstringobligatorio
Valores permitidos:attachment_text
idstring<uuid>obligatorio
filenamestring
statusstring | nullobligatorio

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.

Valores permitidos:pendingokunsupportedencryptedtoo_largeunreadabletimeoutfailednull
flagsstring[]obligatorio

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 | nullobligatorio

A PDF's page count; null for other files

textstring | nullobligatorio

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
403

Restricted API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

Not found

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
410

The email carries malware

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Parámetros
Solicitud
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'
Respuesta
{
  "object": "attachment_text",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filename": "string",
  "status": "pending",
  "flags": [
    "truncated"
  ],
  "pages": 0,
  "text": "string"
}

¿Te ha resultado útil esta página?