ItemsList

В ответе навык передает свойство response.card.type со значением ItemsList:

{
    "card": {
        "type": "ItemsList",
        "header": {
            "text": "Заголовок списка изображений",
        },
        "items": [
            {
                "image_id": "<image_id>",
                "title": "Заголовок для изображения.",
                "description": "Описание изображения.",
                "button": {
                    "text": "Надпись на кнопке",
                    "url": "https://example.com/",
                    "payload": {}
                }
            }
        ],
        "footer": {
            "text": "Текст блока под изображением.",
            "button": {
                "text": "Надпись на кнопке",
                "url": "https://example.com/",
                "payload": {}
            }
        }
    }
}

Посмотреть в интерфейсе

card

Описание карточки — сообщения с поддержкой изображений. Если приложению удается отобразить карточку для пользователя, свойство response.text не используется.

Свойство

Описание

type

string

Обязательное свойство.

Тип карточки. Поддерживаемые значения см. в разделе Формат ответа.

Для списка от 1 до 5 изображений укажите значение ItemsList.

header

object

Заголовок списка изображений.

items[]

array of objects

Набор от 1 до 5 изображений.

footer

object

Кнопки под списком изображений.

card.header

Заголовок списка изображений.

Свойство

Описание

text

string

Обязательное свойство, если передается header.

Текст заголовка.

Максимум 64 символа.

card.items

Набор от 1 до 5 изображений.

Свойство

Описание

image_id

string

Идентификатор изображения, который возвращается в ответ на запрос загрузки.

title

string

Заголовок для изображения.

Максимум 128 символов.

description

string

Описание изображения.

Максимум 256 символов.

button

object

Свойства кликабельного изображения.

card.items.button

Свойства кликабельного изображения.

Свойство

Описание

text

string

Текст, который будет отправлен навыку по нажатию на изображение в качестве команды пользователя.

Максимум 64 символа.

Если это свойство передано с пустым значением, свойство request.command в запросе будет отправлено пустым.

Если это свойство не передано в ответе, Диалоги используют вместо него свойство response.card.items.title.

url

string

URL, который должен открываться по нажатию изображения.

Максимум 1024 байта.

payload

object

Произвольный JSON-объект, который Яндекс Диалоги должны отправить обработчику, если пользователь нажмет изображение.

Максимум 4096 байт.

Кнопки под списком изображений.

Свойство

Описание

text

string

Обязательное свойство, если передается footer.

Текст первой кнопки.

Максимум 64 символа.

button

object

Дополнительная кнопка для списка изображений.

Дополнительная кнопка для списка изображений.

Свойство

Описание

text

string

Текст кнопки, обязателен для каждой кнопки.

Максимум 64 символа.

Если для кнопки не указано свойство url, по нажатию текст кнопки будет отправлен навыку как реплика пользователя.

url

string

URL, который должен открываться по нажатию изображения.

Максимум 1024 байта.

payload

object

Произвольный JSON-объект, который Яндекс Диалоги должны отправить обработчику, если пользователь нажмет изображение.

Максимум 4096 байт.

Предыдущая
ImageGallery
Следующая
start_account_linking