Команды
Передача команды
Команды передаются в массиве items
сообщения ANSWER_TO_USER
. Пример команд в массиве items
:
{
"items": [
{
"command": {
"type": "action",
"action": {
"type": "text",
"deep_link": "Текст"
}
}
},
{
"command": {
"type": "close_app"
}
}
]
}
Описание полей:
Поле | Описание |
---|---|
Обязательное |
Тип команды. Возможные значения см. ниже |
action |
Передается только в командах типа Содержит любое из доступных действий |
permissions |
Передается только в командах типа Содержит список разрешений, которые требуется запросить у пользователя. Доступные значения:
|
smart_app_data |
Передается только в командах типа Валидный JSON-объект с произвольными данными для смартапа |
payment_invoice |
Передается только в командах типа Содержит поле |
Типы команд
Действия
action
— команда, внутри которой можно указать любое из действий.Пример:
{
"command": {
"type": "action",
"action": {
"type": "text",
"text": "текст"
}
}
}
Персональные данные
request_permissions
— запрос разрешений на получение и обработку данных пользователя.Пример:
{
"command": {
"type": "request_permissions",
"permissions": [
"geo",
"read_contacts",
"record_audio",
"push"
]
}
}
Данные для Canvas App
smart_app_data
— команда для передачи данных в Canvas App.
Пример:
{
"command": {
"type": "smart_app_data",
"smart_app_data": {
"param1": "value1",
"param2": "value2"
}
}
}
Закрытие смартапа
close_app
— закрытие смартапа.Пример:
{
"command": {
"type": "close_app"
}
}
Получение инвойса
payment_invoice
— команда для получения инвойса платежа.Пример:
{
"command": {
"type": "payment_invoice",
"payment_invoice": {
"invoice_id": "id платежа",
}
}
}
Отсутствие ответа
do_nothing
— команда, которая используется, если на запрос отвечать не надо. При этом с экрана будут удалены все подсказки, добавленные в предыдущем ответе.Пример:
{
"command": {
"type": "do_nothing"
}
}
Заметили ошибку?
Выделите текст и нажмите Ctrl
+ Enter
, чтобы сообщить нам о ней