Метод для создания предпросмотров ссылок в сообщениях.
Для создания предпросмотров ссылок вам необходимо знать id
сообщения и указать его в URL
запроса.
Изображения вы можете предоставить как публичной ссылкой (параметром image_url
), так и с помощью прямой загрузки файла на наш сервер (параметром image
) через метод Загрузка файлов. Если вы указали оба параметра сразу, то image
является более приоритетным.
Если среди присланных URL-ключей будет выявлена ошибка (такого URL нет в сообщении или боту не прописан в настройках домен указанного URL), то запрос не будет выполнен (не будет создано ни одного предпросмотра).
Запрос
|
|||
---|---|---|---|
link_previews | object* | JSON карта препросмотров ссылок, где каждый ключ - URL, который был получен в исходящем вебхуке о новом сообщении. | |
URL | object* | URL ключ, за которым находится собранный объект предпросмотра ссылки | |
title | string* | Заголовок | |
description | string* | Описание | |
image_url | string | Публичная ссылка на изображение (если вы хотите загрузить файл изображения в Пачку, то используйте параметр image) | |
image | object | Изображение | |
key | string* | Путь к изображению, полученный в результате загрузки файла (каждое изображение в каждом предпросмотре ссылки должно иметь свой уникальный key, не допускается использование одного и того же key в разных предпросмотрах) | |
name | string* | Название изображения (рекомендуется писать вместе с расширением) | |
size | integer* | Размер изображения в байтах | |
... | ... | ... | |
Ответ
|
|||
При безошибочном выполнении запроса тело ответа отсутствует | |||
Возможные ошибки запроса (errors code)
|
|||
- | Бот не имеет доступа к работе с unfurl методом | ||
- | Домен указанного URL не указан в настройках бота | ||
- | Ошибка в формировании JSON карты предпросмотров ссылок | ||
blank | Поле не может быть пустым | ||
exclusion | Поле имеет недопустимое значение | ||
not_found | Не удалось найти | ||
|
{
"link_previews": {
"https://example.com/4176": {
"title": "Статья: Отправка файлов",
"description": "Пример отправки файлов на удаленный сервер",
"image": {
"key": "attaches/files/93746/e354fd79-9jh6-f2hd-fj83-709dae24c763/${filename}",
"name": "files-to-server.jpg",
"size": "695604"
}
},
"https://tasks.example.com/l/38765": {
"title": "Задача: Верстка сайта",
"description": "Необходимо сверстать одностраничный сайт по макету",
"image_url": "https://website.com/img/landing.png"
}
}
}