Передача команды
Команды передаются в массиве items сообщения ANSWER_TO_USER. Пример команд в массиве payload.items:
{
"payload": {
"items": [
{
"command": {
"type": "action",
"action": {
"type": "text",
"text": "Текст",
"should_send_to_backend": true
}
}
}
]
}
}
Типы команд
Действия
action — команда, внутри которой можно указать любое из действий.
{
"type": "action",
"action": {
"type": "text",
"text": "Текст",
"should_send_to_backend": true
}
}
Команда, содержащая одно из действий (передать текст, открыть диплинк, действие на бэкенде смартапа)
Тип команды. Команда, содержащая одно из действий (передать текст, открыть диплинк, действие на бэкенде смартапа)
action
object
oneOf
Тип дейсвия
Текст сообщения от имени пользователя
По умолчанию: true
Указывает, что сообщение нужно не только отобразить в чате с ассистентом, но и отправить в бэкенд смартапа
Тип действия
Диплинк, который нужно открыть. Работает только при вызове смартапа в мобильном приложении
Тип действия
По умолчанию: SERVER_ACTION
Название сообщения
server_action
object
required
Произвольное название действия
Объект с произвольными параметрами действия
Персональные данные
request_permissions — запрос разрешений на получение и обработку данных пользователя.
{
"type": "request_permissions",
"permissions": [
"geo"
]
}
Запрос разрешений на получение и обработку данных пользователя.
geo— запрос на получение геолокации;read_contacts— запрос на получение доступа к списку контактов;record_audio— запрос на запись аудио;push— запрос на отправку push-уведомлений.
Тип команды. Запрос разрешений на получение и обработку данных пользователя
Возможные значения: [geo, read_contacts, record_audio, push]
Cписок разрешений, которые требуется запросить у пользователя. Доступные значения:
Данные для смартапа
smart_app_data — команда для передачи данных в смартап.
{
"type": "smart_app_data",
"smart_app_data": {}
}
Команда для передачи данных в Canvas App.
Тип команды. Команда для передачи данных в Canvas App
Объект с произвольными данными для смартапа
Закрытие смартапа
close_app — закрытие смартапа.
{
"type": "close_app"
}
Команда закрытия смартапа.
Тип команды. Команда закрытия смартапа
Получение инвойса
payment_invoice — команда для получения инвойса платежа.
{
"type": "payment_invoice",
"payment_invoice": {
"invoice_id": "118462a"
}
}
Команда для получения инвойса платежа.
Тип команды
payment_invoice
object
Идентификатор инвойса
Отсутствие ответа
do_nothing — команда, которая используется, если на запрос отвечать не надо. При этом с экрана будут удалены все подсказки, добавленные в предыдущем ответе.
{
"type": "do_nothing"
}
Команда, которая используется, если на запрос отвечать не надо. При этом с экрана будут удалены все подсказки, добавленные в предыдущем ответе
Тип команды