Sign inGet Started
Comenzar
Guías
Referencia de API
SDKs
CLI
Base de conocimientos
Registro de cambios

Get an attachment

GET
/v1/amb/attachments/{attachment_id}
bird amb attachments get <attachment-id>
Respuesta200
{
  "id": "aat_01krdgeqcxet5s7t44vh8rt9mg",
  "business_account_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
  "origin": "received",
  "message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "receipt.pdf",
  "mime_type": "application/pdf"
}

Returns the metadata of an attachment by its aat_ ID. origin says whether a customer sent it, you sent it, or you uploaded it; a message attachment carries its message_id. expires_at is Bird's estimate of when Apple stops holding the attachment. A send within 24 hours of expires_at is refused. An unknown ID returns 404.

Parámetros

attachment_idstring

Attachment identifier. Starts with aat_.

Carga de respuesta

id
string
obligatorio

Send it as attachment_id.

business_account_id
string
obligatorio

The business account Apple holds the attachment for.

origin
string
obligatorio

How Bird obtained an attachment:

  • received: A customer sent it in a message.
  • sent: You sent it in a message by source_url.
  • uploaded: You uploaded it with createAMBAttachment.

Possible values: received, sent, uploaded

message_id
string

The message the attachment belongs to.

name
string
obligatorio

Display filename. May be empty for an attachment stored before this release.

mime_type
string
obligatorio

Media type of the attachment. May be empty for an attachment stored before this release.

size
integer
obligatorio

Attachment size in bytes. May be 0 for an attachment stored before this release.

expires_at
string
obligatorio

Bird's estimate of when Apple stops holding the attachment, 30 days after it was received, uploaded or last sent. A send within 24 hours of this time is refused.

created_at
string
obligatorio

When Bird stored the attachment.

Recursos relacionados

Continúa con la documentación, guías y ejemplos de este tema.

Obtener un resumen de implementación