Message attachments

YoLead exposes attachment metadata for Telegram Bot, Telegram Account, MAX, VK, email, Facebook, and Instagram messages. For email, this includes Inbox messages and external messages discovered through Sent-folder synchronization. Attachment descriptors can appear in:

messages[].attachments from GET /v1/tickets/{ticketId}/history;
data.message.attachments in ticket.created and message.incoming webhooks.

Standard attachment descriptors have this shape:

{
  "id": "64b000000000000000000002",
  "kind": "image",
  "fileName": "photo.jpg",
  "mimeType": "image/jpeg",
  "size": 4096,
  "width": 1280,
  "height": 720,
  "duration": 4
}

Field	Type	Required	Description
`id`	`string`	Yes	YoLead attachment identifier.
`kind`	`string`	Yes	`image`, `animation`, `audio`, `voice`, `video`, `video_note`, `document`, `sticker`, or `unknown`.
`accessMode`	`external`	No	Indicates an attachment available through an external source.
`fileName`	`string`	No	Original filename when the source channel supplies one.
`mimeType`	`string`	No	MIME type when known.
`size`	`integer`	No	File size in bytes when known.
`width`	`integer`	No	Media width in pixels when known.
`height`	`integer`	No	Media height in pixels when known.
`duration`	`integer`	No	Audio, animation, or video duration in seconds when known.

Only id and kind are guaranteed. Integrations must tolerate missing optional metadata and attachment kinds added in future versions. Standard descriptors do not include provider identifiers, temporary provider URLs, credentials, storage paths, or storage state.

VK provider-history descriptors

VK history read from the source channel can contain a separate descriptor format identified by source: "vk". Its id is an opaque string rather than a YoLead attachment ObjectId. In addition to kind and the optional metadata above, this format can include contentUrl, previewUrl, and externalUrl supplied by VK. These URLs are optional and their availability can change. The source and URL fields belong to this separate format; accessMode belongs to the standard descriptor. Neither format includes YoLead storage details or authentication credentials. Treat attachment identifiers as opaque values.

Telegram albums

Telegram sends each album item as a separate message. Ticket history can include the same optional mediaGroupId on those messages so an integration can group them. Each Telegram message contains at most one attachment descriptor. mediaGroupId is currently part of Public API ticket history messages; it is not included in message webhook objects.

Availability and history

Existing stored messages are not automatically backfilled, so older messages can have an empty attachments array even when the original provider message contained a file. Imported Telegram Account history can include attachment metadata, and VK provider history can include the separate descriptors described above. Metadata availability in imported history depends on the channel. The Public API exposes attachment metadata but does not currently provide an API-key-authenticated endpoint for downloading attachment bytes. YoLead’s authenticated application and embedded iframe can display or download files when they are still available. Do not construct a download URL from the attachment id.

Start

Integration basics

REST API

Webhooks

Embed iframe

Resources

VK provider-history descriptors

Telegram albums

Availability and history

​VK provider-history descriptors

​Telegram albums

​Availability and history

VK provider-history descriptors

Telegram albums

Availability and history