Команды в SmartApp API

Обновлено 19 февраля 2025

SmartApp API

Передача команды

Команды передаются в массиве 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
  }
}

Команда, содержащая одно из действий (передать текст, открыть диплинк, действие на бэкенде смартапа)

type

string

Тип команды. Команда, содержащая одно из действий (передать текст, открыть диплинк, действие на бэкенде смартапа)

action

object

oneOf

• text
• deep_link
• server_action

type

string

Тип дейсвия

text

string

required

Текст сообщения от имени пользователя

should_send_to_backend

boolean

По умолчанию: true

Указывает, что сообщение нужно не только отобразить в чате с ассистентом, но и отправить в бэкенд смартапа

type

string

Тип действия

deep_link

string

required

Диплинк, который нужно открыть. Работает только при вызове смартапа в мобильном приложении и в SberPortal

type

string

Тип действия

message_name

string

По умолчанию: SERVER_ACTION

Название сообщения

server_action

object

required

action_id

string

Произвольное название действия

payload

object

Объект с произвольными параметрами действия

Персональные данные

request_permissions — запрос разрешений на получение и обработку данных пользователя.

• Пример
• Описание

{
  "type": "request_permissions",
  "permissions": [
    "geo"
  ]
}

Запрос разрешений на получение и обработку данных пользователя.

type

string

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

permissions
string[]
Возможные значения: [geo, read_contacts, record_audio, push]
Cписок разрешений, которые требуется запросить у пользователя. Доступные значения:
• geo — запрос на получение геолокации;
• read_contacts — запрос на получение доступа к списку контактов;
• record_audio — запрос на запись аудио;
• push — запрос на отправку push-уведомлений.

Данные для смартапа

smart_app_data — команда для передачи данных в смартап.

• Пример
• Описание

{
  "type": "smart_app_data",
  "smart_app_data": {}
}

Команда для передачи данных в Canvas App.

type

string

Тип команды. Команда для передачи данных в Canvas App

smart_app_data

object

Объект с произвольными данными для смартапа

Закрытие смартапа

close_app — закрытие смартапа.

• Пример
• Описание

{
  "type": "close_app"
}

Команда закрытия смартапа.

type

string

Тип команды. Команда закрытия смартапа

Получение инвойса

payment_invoice — команда для получения инвойса платежа.

• Пример
• Описание

{
  "type": "payment_invoice",
  "payment_invoice": {
    "invoice_id": "118462a"
  }
}

Команда для получения инвойса платежа.

type

string

Тип команды

payment_invoice

object

invoice_id

string

Идентификатор инвойса

Отсутствие ответа

do_nothing — команда, которая используется, если на запрос отвечать не надо. При этом с экрана будут удалены все подсказки, добавленные в предыдущем ответе.

• Пример
• Описание

{
  "type": "do_nothing"
}

Команда, которая используется, если на запрос отвечать не надо. При этом с экрана будут удалены все подсказки, добавленные в предыдущем ответе

type

string

Тип команды