Вставка карточек
С помощью карточек скилл может отвечать различными аудиовизуальными элементами, помимо текста и речи.
Чтобы вставить карточку, добавьте объект card (структура описана ниже) в response.
Изображения
В ответ из внешнего скилла можно вставлять картинки. Чтобы использовать своё изображение, загрузите его в специальную форму на странице редактирования информации о скилле. После этого оно отобразится рядом с формой загрузки вместе со своим идентификатором. Идентификатор изображения необходимо указывать в ответе внешнего скилла в поле image_id.
Обратите внимание: если вы тестируете навык через отладчик скиллов, для работы с изображениями необходимо указать ID навыка в Webhook URL.
Одно изображение
Структура объекта card для одной картинки
| Поле | Тип | Описание |
|---|---|---|
type | string | Обязательное. Тип карточки. Значение должно быть "BigImage". |
image_id | integer | Обязательное. ID изображения из раздела Медиафайлы в настройках скилла. |
Пример ответа с одной картинкой (BigImage)
{
"response":{
"text":"Возвращаю картинку.",
"tts":"Возвращаю картинку.",
"card":{
"type":"BigImage",
"image_id":239017
},
"end_session":true
},
"session":{
"session_id":"574d41e0-a41e-4028-a73a-6f5b5bfed299",
"message_id":0,
"user_id":"6953b29afe19e372ecdd34d07b3eae3c2f69b9f04e8cb15e157c4a9e056d58ee"
},
"version":"1.0"
}
Набор изображений
Структура объекта card для набора картинок
| Поле | Тип | Описание |
|---|---|---|
type | string | Обязательное. Тип карточки. Значение должно быть "ItemsList". |
items | array | Обязательное. Список изображений, каждый элемент которого является объектом с обязательным полем image_id. |
Пример ответа с набором картинок (ItemsList)
{
"response":{
"text":"Возвращаю набор картинок.",
"tts":"Возвращаю набор картинок.",
"card":{
"type": "ItemsList",
"items": [
{"image_id": 4572392347},
{"image_id": 4572342348}
]
},
"end_session":true
},
"session":{
"session_id":"574d41e0-a41e-4028-a73a-6f5b5bfed299",
"message_id":0,
"user_id":"6953b29afe19e372ecdd34d07b3eae3c2f69b9f04e8cb15e157c4a9e056d58ee"
},
"version":"1.0"
}
Карточка мини-приложения
В скилле предусматривается ответ карточкой мини-приложения. Для этого вам потребуется только его адрес, например: https://vk.com/taxi.
Структура объекта card для мини-приложения
| Поле | Тип | Описание |
|---|---|---|
type | string | Обязательное. Тип карточки. Значение должно быть "MiniApp". |
url | string | Обязательное. Адрес мини-приложения. |
Адрес может содержать якоря и параметры, если ваша ссылка должна вести пользователя в конкретное место мини-приложения.
Пример ответа с мини-приложением
{
"response":{
"text":"Возвращаю карточку мини-приложения.",
"tts":"Возвращаю карточку мини-приложения.",
"card":{
"type": "MiniApp",
"url": "[https://vk.com/taxi"],
},
"end_session":true
},
"session":{
"session_id":"574d41e0-a41e-4028-a73a-6f5b5bfed299",
"message_id":0,
"user_id":"6953b29afe19e372ecdd34d07b3eae3c2f69b9f04e8cb15e157c4a9e056d58ee"
},
"version":"1.0"
}
Стилизованная ссылка
Данную карточку можно использовать для стилизации любых ссылок с помощью изображения, заголовка и описания.
Структура объекта card для стилизованной ссылки
| Поле | Тип | Описание |
|---|---|---|
type | string | Обязательное. Тип карточки. Значение должно быть "Link". |
url | string | Обязательное. Непосредственно сама ссылка. |
title | string | Обязательное. Заголовок ссылки. |
text | string | Обязательное. Описание ссылки. |
image_id | integer | Обязательное. ID изображения из раздела Медиафайлы в настройках скилла. |
Пример ответа со стилизованной ссылкой (Link)
{
"response":{
"text":"Возвращаю стилизованную ссылку.",
"tts":"Возвращаю стилизованную ссылку.",
"card":{
"type": "Link",
"url": "[https://vk.com/"],
"title": "Заголовок",
"text": "Описание",
"image_id": 3572018
},
"end_session":true
},
"session":{
"session_id":"574d41e0-a41e-4028-a73a-6f5b5bfed299",
"message_id":0,
"user_id":"6953b29afe19e372ecdd34d07b3eae3c2f69b9f04e8cb15e157c4a9e056d58ee"
},
"version":"1.0"
}
Вставка нескольких карточек
Чтобы последовательно показать несколько карточек, положите их в массив commands объекта response в нужном порядке.
Пример ответа с несколькими карточками
"response": {
"text": "Возвращаю 2 карточки.",
"tts": "Возвращаю 2 карточки.",
"commands": [
{
"type": "BigImage",
"image_id": 239017
},
{
"type": "Link",
"url": "[https://vk.com/"],
"title": "Заголовок",
"text": "Описание",
"image_id": 3572018
}
],
"end_session":true
},
"session": {
"session_id": "574d41e0-a41e-4028-a73a-6f5b5bfed299",
"message_id": 0,
"user_id": "6953b29afe19e372ecdd34d07b3eae3c2f69b9f04e8cb15e157c4a9e056d58ee"
},
"version": "1.0"
}